CheckHub API v1.95.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Welcome to CheckHub API documentation
Every method is protected and requires you to have a valid API Token.
If you don't have it yet, we strongly advise you to start by creating a new one.
To do so :
- Log into CheckHub ADMIN using your User/Password credentials
- Go to Settings > API Tokens
- Create a new token (you can use a token name like
Development
orStaging
)
If you have any questions, please ask !
Please use the following link for bug report: https://form.asana.com/?k=OngbuzmFRVTp_ZMEMuUAbg&d=718323232107850
For convenient tracking of all changes in the API, please use this link: https://changelog.checkhub.io
Postman collection with examples: https://www.postman.com/checkhubio/checkhub-public/overview
Base URLs:
Email: CheckHub Technical Team
Authentication
-
API Key (token)
- Parameter Name: Authorization, in: header. Access token created through the admin panel eg. "D2NS9gyuq0hkChHE9fYLb49v3..."
-
API Key (csrf)
- Parameter Name: X-CSRF-TOKEN, in: header. Candidate token link eg. "02yEXtzgnTPpuHwrL"
-
API Key (companyToken)
- Parameter Name: Authorization, in: header. Integration company token created through the admin panel eg. "D2NS9gyuq0hkChHE9fYLb49v3..."
Account
Create new account
Code samples
POST https://api.checkhub.io/accounts HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"aboutText": {
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedBoxText": {
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedText": {
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/accounts',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"aboutText": {
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedBoxText": {
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedText": {
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
}
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/accounts',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/accounts', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/accounts',
params: {
}, headers: headers
p JSON.parse(result)
POST /accounts
Body parameter
{
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"aboutText": {
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedBoxText": {
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedText": {
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
}
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
name | body | string | true | Account name |
reference | body | string | false | Account reference (unique identifier for the account) |
welcomeText | body | accountWelcomeTextBase | false | This scheme is a collection of account welcome text for users in different languages. |
» en | body | string(html) | false | Used for users whose language is "English" |
» fr | body | string(html) | false | Used for users whose language is "Français" |
» nl | body | string(html) | false | Used for users whose language is "Nederlands" |
» de | body | string(html) | false | Used for users whose language is "Deutsch" |
» it | body | string(html) | false | Used for users whose language is "Italiano" |
» pl | body | string(html) | false | Used for users whose language is "Polski" |
» ro | body | string(html) | false | Used for users whose language is "Română" |
» sq | body | string(html) | false | Used for users whose language is "Shqip" |
» be | body | string(html) | false | Used for users whose language is "Беларуская" |
» bg | body | string(html) | false | Used for users whose language is "Български" |
» hr | body | string(html) | false | Used for users whose language is "Hrvatski" |
» cs | body | string(html) | false | Used for users whose language is "Čeština" |
» da | body | string(html) | false | Used for users whose language is "Dansk" |
» et | body | string(html) | false | Used for users whose language is "Eesti" |
» fi | body | string(html) | false | Used for users whose language is "Suomi" |
» el | body | string(html) | false | Used for users whose language is "Ελληνικά" |
» hu | body | string(html) | false | Used for users whose language is "Magyar" |
» is | body | string(html) | false | Used for users whose language is "Íslenska" |
» ga | body | string(html) | false | Used for users whose language is "Gaeilge" |
» lv | body | string(html) | false | Used for users whose language is "Latviešu" |
» lt | body | string(html) | false | Used for users whose language is "Lietuvių" |
» mk | body | string(html) | false | Used for users whose language is "Македонски" |
» mt | body | string(html) | false | Used for users whose language is "Malti" |
» no | body | string(html) | false | Used for users whose language is "Norsk" |
» pt | body | string(html) | false | Used for users whose language is "Português" |
» ru | body | string(html) | false | Used for users whose language is "Русский" |
» sr | body | string(html) | false | Used for users whose language is "Српски" |
» sk | body | string(html) | false | Used for users whose language is "Slovenčina" |
» sl | body | string(html) | false | Used for users whose language is "Slovenščina" |
» es | body | string(html) | false | Used for users whose language is "Español" |
» sv | body | string(html) | false | Used for users whose language is "Svenska" |
» uk | body | string(html) | false | Used for users whose language is "Українська" |
» cy | body | string(html) | false | Used for users whose language is "Cymraeg" |
aboutText | body | accountAboutTextBase | false | This scheme is a collection of account about text for users in different languages. |
» en | body | string(html) | false | Used for users whose language is "English" |
» fr | body | string(html) | false | Used for users whose language is "Français" |
» nl | body | string(html) | false | Used for users whose language is "Nederlands" |
» de | body | string(html) | false | Used for users whose language is "Deutsch" |
» it | body | string(html) | false | Used for users whose language is "Italiano" |
» pl | body | string(html) | false | Used for users whose language is "Polski" |
» ro | body | string(html) | false | Used for users whose language is "Română" |
» sq | body | string(html) | false | Used for users whose language is "Shqip" |
» be | body | string(html) | false | Used for users whose language is "Беларуская" |
» bg | body | string(html) | false | Used for users whose language is "Български" |
» hr | body | string(html) | false | Used for users whose language is "Hrvatski" |
» cs | body | string(html) | false | Used for users whose language is "Čeština" |
» da | body | string(html) | false | Used for users whose language is "Dansk" |
» et | body | string(html) | false | Used for users whose language is "Eesti" |
» fi | body | string(html) | false | Used for users whose language is "Suomi" |
» el | body | string(html) | false | Used for users whose language is "Ελληνικά" |
» hu | body | string(html) | false | Used for users whose language is "Magyar" |
» is | body | string(html) | false | Used for users whose language is "Íslenska" |
» ga | body | string(html) | false | Used for users whose language is "Gaeilge" |
» lv | body | string(html) | false | Used for users whose language is "Latviešu" |
» lt | body | string(html) | false | Used for users whose language is "Lietuvių" |
» mk | body | string(html) | false | Used for users whose language is "Македонски" |
» mt | body | string(html) | false | Used for users whose language is "Malti" |
» no | body | string(html) | false | Used for users whose language is "Norsk" |
» pt | body | string(html) | false | Used for users whose language is "Português" |
» ru | body | string(html) | false | Used for users whose language is "Русский" |
» sr | body | string(html) | false | Used for users whose language is "Српски" |
» sk | body | string(html) | false | Used for users whose language is "Slovenčina" |
» sl | body | string(html) | false | Used for users whose language is "Slovenščina" |
» es | body | string(html) | false | Used for users whose language is "Español" |
» sv | body | string(html) | false | Used for users whose language is "Svenska" |
» uk | body | string(html) | false | Used for users whose language is "Українська" |
» cy | body | string(html) | false | Used for users whose language is "Cymraeg" |
completedBoxText | body | accountCompletedBoxTextBase | false | This scheme is a collection of account completed box text for users in different languages. |
» en | body | string(html) | false | Used for users whose language is "English" |
» fr | body | string(html) | false | Used for users whose language is "Français" |
» nl | body | string(html) | false | Used for users whose language is "Nederlands" |
» de | body | string(html) | false | Used for users whose language is "Deutsch" |
» it | body | string(html) | false | Used for users whose language is "Italiano" |
» pl | body | string(html) | false | Used for users whose language is "Polski" |
» ro | body | string(html) | false | Used for users whose language is "Română" |
» sq | body | string(html) | false | Used for users whose language is "Shqip" |
» be | body | string(html) | false | Used for users whose language is "Беларуская" |
» bg | body | string(html) | false | Used for users whose language is "Български" |
» hr | body | string(html) | false | Used for users whose language is "Hrvatski" |
» cs | body | string(html) | false | Used for users whose language is "Čeština" |
» da | body | string(html) | false | Used for users whose language is "Dansk" |
» et | body | string(html) | false | Used for users whose language is "Eesti" |
» fi | body | string(html) | false | Used for users whose language is "Suomi" |
» el | body | string(html) | false | Used for users whose language is "Ελληνικά" |
» hu | body | string(html) | false | Used for users whose language is "Magyar" |
» is | body | string(html) | false | Used for users whose language is "Íslenska" |
» ga | body | string(html) | false | Used for users whose language is "Gaeilge" |
» lv | body | string(html) | false | Used for users whose language is "Latviešu" |
» lt | body | string(html) | false | Used for users whose language is "Lietuvių" |
» mk | body | string(html) | false | Used for users whose language is "Македонски" |
» mt | body | string(html) | false | Used for users whose language is "Malti" |
» no | body | string(html) | false | Used for users whose language is "Norsk" |
» pt | body | string(html) | false | Used for users whose language is "Português" |
» ru | body | string(html) | false | Used for users whose language is "Русский" |
» sr | body | string(html) | false | Used for users whose language is "Српски" |
» sk | body | string(html) | false | Used for users whose language is "Slovenčina" |
» sl | body | string(html) | false | Used for users whose language is "Slovenščina" |
» es | body | string(html) | false | Used for users whose language is "Español" |
» sv | body | string(html) | false | Used for users whose language is "Svenska" |
» uk | body | string(html) | false | Used for users whose language is "Українська" |
» cy | body | string(html) | false | Used for users whose language is "Cymraeg" |
completedText | body | accountCompletedTextBase | false | This scheme is a collection of account completed text for users in different languages. |
» en | body | string(html) | false | Used for users whose language is "English" |
» fr | body | string(html) | false | Used for users whose language is "Français" |
» nl | body | string(html) | false | Used for users whose language is "Nederlands" |
» de | body | string(html) | false | Used for users whose language is "Deutsch" |
» it | body | string(html) | false | Used for users whose language is "Italiano" |
» pl | body | string(html) | false | Used for users whose language is "Polski" |
» ro | body | string(html) | false | Used for users whose language is "Română" |
» sq | body | string(html) | false | Used for users whose language is "Shqip" |
» be | body | string(html) | false | Used for users whose language is "Беларуская" |
» bg | body | string(html) | false | Used for users whose language is "Български" |
» hr | body | string(html) | false | Used for users whose language is "Hrvatski" |
» cs | body | string(html) | false | Used for users whose language is "Čeština" |
» da | body | string(html) | false | Used for users whose language is "Dansk" |
» et | body | string(html) | false | Used for users whose language is "Eesti" |
» fi | body | string(html) | false | Used for users whose language is "Suomi" |
» el | body | string(html) | false | Used for users whose language is "Ελληνικά" |
» hu | body | string(html) | false | Used for users whose language is "Magyar" |
» is | body | string(html) | false | Used for users whose language is "Íslenska" |
» ga | body | string(html) | false | Used for users whose language is "Gaeilge" |
» lv | body | string(html) | false | Used for users whose language is "Latviešu" |
» lt | body | string(html) | false | Used for users whose language is "Lietuvių" |
» mk | body | string(html) | false | Used for users whose language is "Македонски" |
» mt | body | string(html) | false | Used for users whose language is "Malti" |
» no | body | string(html) | false | Used for users whose language is "Norsk" |
» pt | body | string(html) | false | Used for users whose language is "Português" |
» ru | body | string(html) | false | Used for users whose language is "Русский" |
» sr | body | string(html) | false | Used for users whose language is "Српски" |
» sk | body | string(html) | false | Used for users whose language is "Slovenčina" |
» sl | body | string(html) | false | Used for users whose language is "Slovenščina" |
» es | body | string(html) | false | Used for users whose language is "Español" |
» sv | body | string(html) | false | Used for users whose language is "Svenska" |
» uk | body | string(html) | false | Used for users whose language is "Українська" |
» cy | body | string(html) | false | Used for users whose language is "Cymraeg" |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"aboutText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedBoxText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | account |
Get account collection
Code samples
GET https://api.checkhub.io/accounts HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/accounts',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/accounts',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/accounts', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/accounts',
params: {
}, headers: headers
p JSON.parse(result)
GET /accounts
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response. min: 1 , max: 100 , default: 10 |
skip | query | number | false | Number of items skipped during the selection. min: 0 , default: 0 |
order | query | string | false | Account collection order |
filter[name] | query | string | false | Search by account name |
filter[reference] | query | string | false | Search by account reference |
includeShared | query | boolean | false | To include accounts from the companies of the same company group |
includeWelcomeText | query | boolean | false | To include account 'welcomeText' relation |
includeAboutText | query | boolean | false | To include account 'aboutText' relation |
includeCompletedBoxText | query | boolean | false | To include account 'completedBoxText' relation |
includeCompletedText | query | boolean | false | To include account 'completedText' relation |
includeCandidates | query | boolean | false | To include account 'candidates' relation. deprecated |
includeCandidatesCount | query | boolean | false | To include account 'candidatesCount' field which will show count of all related candidates |
Enumerated Values
Parameter | Value |
---|---|
order | name asc |
order | name desc |
order | createdAt asc |
order | createdAt desc |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"aboutText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedBoxText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidates": [
{
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | accountFindResponse |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
200 | X-CURRENT-PAGE | integer | Current page | |
200 | X-PAGE-OFFSET | integer | Current offset | |
200 | X-PAGE-LIMIT | integer | Current limit | |
200 | X-TOTAL-PAGES | integer | The total number of pages. | |
200 | X-TOTAL-RECORDS | integer | The total number of items. |
Delete account by {{id}}
Code samples
DELETE https://api.checkhub.io/accounts/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/accounts/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/accounts/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.delete('https://api.checkhub.io/accounts/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.delete 'https://api.checkhub.io/accounts/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /accounts/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be deleted |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | successfullyCompletedRequest |
Get account by {{id}}.
Code samples
GET https://api.checkhub.io/accounts/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/accounts/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/accounts/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/accounts/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/accounts/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /accounts/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
includeShared | query | boolean | false | To include accounts from the companies of the same company group |
includeCandidates | query | boolean | false | To include account 'candidates' relation. deprecated |
includeWelcomeText | query | boolean | false | To include account 'welcomeText' relation |
includeAboutText | query | boolean | false | To include account 'aboutText' relation |
includeCompletedBoxText | query | boolean | false | To include account 'completedBoxText' relation |
includeCompletedText | query | boolean | false | To include account 'completedText' relation |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"aboutText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedBoxText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidates": [
{
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | accountFindByIdResponse |
Update account by {{id}}
Code samples
PATCH https://api.checkhub.io/accounts/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"aboutText": {
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedBoxText": {
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedText": {
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/accounts/{id}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"aboutText": {
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedBoxText": {
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedText": {
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
}
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/accounts/{id}',
{
method: 'PATCH',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.patch('https://api.checkhub.io/accounts/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.patch 'https://api.checkhub.io/accounts/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /accounts/{id}
Body parameter
{
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"aboutText": {
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedBoxText": {
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedText": {
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
}
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be updated |
name | body | string | false | Account name |
reference | body | string | false | Account reference (unique identifier for the account) |
welcomeText | body | accountWelcomeTextBase | false | This scheme is a collection of account welcome text for users in different languages. |
» en | body | string(html) | false | Used for users whose language is "English" |
» fr | body | string(html) | false | Used for users whose language is "Français" |
» nl | body | string(html) | false | Used for users whose language is "Nederlands" |
» de | body | string(html) | false | Used for users whose language is "Deutsch" |
» it | body | string(html) | false | Used for users whose language is "Italiano" |
» pl | body | string(html) | false | Used for users whose language is "Polski" |
» ro | body | string(html) | false | Used for users whose language is "Română" |
» sq | body | string(html) | false | Used for users whose language is "Shqip" |
» be | body | string(html) | false | Used for users whose language is "Беларуская" |
» bg | body | string(html) | false | Used for users whose language is "Български" |
» hr | body | string(html) | false | Used for users whose language is "Hrvatski" |
» cs | body | string(html) | false | Used for users whose language is "Čeština" |
» da | body | string(html) | false | Used for users whose language is "Dansk" |
» et | body | string(html) | false | Used for users whose language is "Eesti" |
» fi | body | string(html) | false | Used for users whose language is "Suomi" |
» el | body | string(html) | false | Used for users whose language is "Ελληνικά" |
» hu | body | string(html) | false | Used for users whose language is "Magyar" |
» is | body | string(html) | false | Used for users whose language is "Íslenska" |
» ga | body | string(html) | false | Used for users whose language is "Gaeilge" |
» lv | body | string(html) | false | Used for users whose language is "Latviešu" |
» lt | body | string(html) | false | Used for users whose language is "Lietuvių" |
» mk | body | string(html) | false | Used for users whose language is "Македонски" |
» mt | body | string(html) | false | Used for users whose language is "Malti" |
» no | body | string(html) | false | Used for users whose language is "Norsk" |
» pt | body | string(html) | false | Used for users whose language is "Português" |
» ru | body | string(html) | false | Used for users whose language is "Русский" |
» sr | body | string(html) | false | Used for users whose language is "Српски" |
» sk | body | string(html) | false | Used for users whose language is "Slovenčina" |
» sl | body | string(html) | false | Used for users whose language is "Slovenščina" |
» es | body | string(html) | false | Used for users whose language is "Español" |
» sv | body | string(html) | false | Used for users whose language is "Svenska" |
» uk | body | string(html) | false | Used for users whose language is "Українська" |
» cy | body | string(html) | false | Used for users whose language is "Cymraeg" |
aboutText | body | accountAboutTextBase | false | This scheme is a collection of account about text for users in different languages. |
» en | body | string(html) | false | Used for users whose language is "English" |
» fr | body | string(html) | false | Used for users whose language is "Français" |
» nl | body | string(html) | false | Used for users whose language is "Nederlands" |
» de | body | string(html) | false | Used for users whose language is "Deutsch" |
» it | body | string(html) | false | Used for users whose language is "Italiano" |
» pl | body | string(html) | false | Used for users whose language is "Polski" |
» ro | body | string(html) | false | Used for users whose language is "Română" |
» sq | body | string(html) | false | Used for users whose language is "Shqip" |
» be | body | string(html) | false | Used for users whose language is "Беларуская" |
» bg | body | string(html) | false | Used for users whose language is "Български" |
» hr | body | string(html) | false | Used for users whose language is "Hrvatski" |
» cs | body | string(html) | false | Used for users whose language is "Čeština" |
» da | body | string(html) | false | Used for users whose language is "Dansk" |
» et | body | string(html) | false | Used for users whose language is "Eesti" |
» fi | body | string(html) | false | Used for users whose language is "Suomi" |
» el | body | string(html) | false | Used for users whose language is "Ελληνικά" |
» hu | body | string(html) | false | Used for users whose language is "Magyar" |
» is | body | string(html) | false | Used for users whose language is "Íslenska" |
» ga | body | string(html) | false | Used for users whose language is "Gaeilge" |
» lv | body | string(html) | false | Used for users whose language is "Latviešu" |
» lt | body | string(html) | false | Used for users whose language is "Lietuvių" |
» mk | body | string(html) | false | Used for users whose language is "Македонски" |
» mt | body | string(html) | false | Used for users whose language is "Malti" |
» no | body | string(html) | false | Used for users whose language is "Norsk" |
» pt | body | string(html) | false | Used for users whose language is "Português" |
» ru | body | string(html) | false | Used for users whose language is "Русский" |
» sr | body | string(html) | false | Used for users whose language is "Српски" |
» sk | body | string(html) | false | Used for users whose language is "Slovenčina" |
» sl | body | string(html) | false | Used for users whose language is "Slovenščina" |
» es | body | string(html) | false | Used for users whose language is "Español" |
» sv | body | string(html) | false | Used for users whose language is "Svenska" |
» uk | body | string(html) | false | Used for users whose language is "Українська" |
» cy | body | string(html) | false | Used for users whose language is "Cymraeg" |
completedBoxText | body | accountCompletedBoxTextBase | false | This scheme is a collection of account completed box text for users in different languages. |
» en | body | string(html) | false | Used for users whose language is "English" |
» fr | body | string(html) | false | Used for users whose language is "Français" |
» nl | body | string(html) | false | Used for users whose language is "Nederlands" |
» de | body | string(html) | false | Used for users whose language is "Deutsch" |
» it | body | string(html) | false | Used for users whose language is "Italiano" |
» pl | body | string(html) | false | Used for users whose language is "Polski" |
» ro | body | string(html) | false | Used for users whose language is "Română" |
» sq | body | string(html) | false | Used for users whose language is "Shqip" |
» be | body | string(html) | false | Used for users whose language is "Беларуская" |
» bg | body | string(html) | false | Used for users whose language is "Български" |
» hr | body | string(html) | false | Used for users whose language is "Hrvatski" |
» cs | body | string(html) | false | Used for users whose language is "Čeština" |
» da | body | string(html) | false | Used for users whose language is "Dansk" |
» et | body | string(html) | false | Used for users whose language is "Eesti" |
» fi | body | string(html) | false | Used for users whose language is "Suomi" |
» el | body | string(html) | false | Used for users whose language is "Ελληνικά" |
» hu | body | string(html) | false | Used for users whose language is "Magyar" |
» is | body | string(html) | false | Used for users whose language is "Íslenska" |
» ga | body | string(html) | false | Used for users whose language is "Gaeilge" |
» lv | body | string(html) | false | Used for users whose language is "Latviešu" |
» lt | body | string(html) | false | Used for users whose language is "Lietuvių" |
» mk | body | string(html) | false | Used for users whose language is "Македонски" |
» mt | body | string(html) | false | Used for users whose language is "Malti" |
» no | body | string(html) | false | Used for users whose language is "Norsk" |
» pt | body | string(html) | false | Used for users whose language is "Português" |
» ru | body | string(html) | false | Used for users whose language is "Русский" |
» sr | body | string(html) | false | Used for users whose language is "Српски" |
» sk | body | string(html) | false | Used for users whose language is "Slovenčina" |
» sl | body | string(html) | false | Used for users whose language is "Slovenščina" |
» es | body | string(html) | false | Used for users whose language is "Español" |
» sv | body | string(html) | false | Used for users whose language is "Svenska" |
» uk | body | string(html) | false | Used for users whose language is "Українська" |
» cy | body | string(html) | false | Used for users whose language is "Cymraeg" |
completedText | body | accountCompletedTextBase | false | This scheme is a collection of account completed text for users in different languages. |
» en | body | string(html) | false | Used for users whose language is "English" |
» fr | body | string(html) | false | Used for users whose language is "Français" |
» nl | body | string(html) | false | Used for users whose language is "Nederlands" |
» de | body | string(html) | false | Used for users whose language is "Deutsch" |
» it | body | string(html) | false | Used for users whose language is "Italiano" |
» pl | body | string(html) | false | Used for users whose language is "Polski" |
» ro | body | string(html) | false | Used for users whose language is "Română" |
» sq | body | string(html) | false | Used for users whose language is "Shqip" |
» be | body | string(html) | false | Used for users whose language is "Беларуская" |
» bg | body | string(html) | false | Used for users whose language is "Български" |
» hr | body | string(html) | false | Used for users whose language is "Hrvatski" |
» cs | body | string(html) | false | Used for users whose language is "Čeština" |
» da | body | string(html) | false | Used for users whose language is "Dansk" |
» et | body | string(html) | false | Used for users whose language is "Eesti" |
» fi | body | string(html) | false | Used for users whose language is "Suomi" |
» el | body | string(html) | false | Used for users whose language is "Ελληνικά" |
» hu | body | string(html) | false | Used for users whose language is "Magyar" |
» is | body | string(html) | false | Used for users whose language is "Íslenska" |
» ga | body | string(html) | false | Used for users whose language is "Gaeilge" |
» lv | body | string(html) | false | Used for users whose language is "Latviešu" |
» lt | body | string(html) | false | Used for users whose language is "Lietuvių" |
» mk | body | string(html) | false | Used for users whose language is "Македонски" |
» mt | body | string(html) | false | Used for users whose language is "Malti" |
» no | body | string(html) | false | Used for users whose language is "Norsk" |
» pt | body | string(html) | false | Used for users whose language is "Português" |
» ru | body | string(html) | false | Used for users whose language is "Русский" |
» sr | body | string(html) | false | Used for users whose language is "Српски" |
» sk | body | string(html) | false | Used for users whose language is "Slovenčina" |
» sl | body | string(html) | false | Used for users whose language is "Slovenščina" |
» es | body | string(html) | false | Used for users whose language is "Español" |
» sv | body | string(html) | false | Used for users whose language is "Svenska" |
» uk | body | string(html) | false | Used for users whose language is "Українська" |
» cy | body | string(html) | false | Used for users whose language is "Cymraeg" |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"aboutText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedBoxText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | account |
Admin User
Get admin user collection
Code samples
GET https://api.checkhub.io/adminUsers HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/adminUsers', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/adminUsers',
params: {
}, headers: headers
p JSON.parse(result)
GET /adminUsers
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response. min: 1 , max: 100 , default: 10 |
skip | query | number | false | Number of items skipped during the selection. min: 0 , default: 0 |
filter[name] | query | string | false | Search by admin user firstName, lastName, email |
filter[languages][] | query | string | false | Search by admin language (or) |
includeSignature | query | boolean | false | To include admin user 'signature' relation |
includeSignatureOriginal | query | boolean | false | To include admin user 'signature' relation 'original' relation |
includeSignatureBlack | query | boolean | false | To include admin user 'signature' relation 'black' relation |
includeSignatureWhite | query | boolean | false | To include admin user 'signature' relation 'white' relation |
includeCompany | query | boolean | false | To include admin user 'company' relation |
Enumerated Values
Parameter | Value |
---|---|
filter[languages][] | en |
filter[languages][] | fr |
filter[languages][] | nl |
filter[languages][] | de |
filter[languages][] | it |
filter[languages][] | pl |
filter[languages][] | ro |
filter[languages][] | sq |
filter[languages][] | be |
filter[languages][] | bg |
filter[languages][] | hr |
filter[languages][] | cs |
filter[languages][] | da |
filter[languages][] | et |
filter[languages][] | fi |
filter[languages][] | el |
filter[languages][] | hu |
filter[languages][] | is |
filter[languages][] | ga |
filter[languages][] | lv |
filter[languages][] | lt |
filter[languages][] | mk |
filter[languages][] | mt |
filter[languages][] | no |
filter[languages][] | pt |
filter[languages][] | ru |
filter[languages][] | sr |
filter[languages][] | sk |
filter[languages][] | sl |
filter[languages][] | es |
filter[languages][] | sv |
filter[languages][] | uk |
filter[languages][] | cy |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"lastActivityAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"isOwner": false,
"company": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it",
"pl",
"ro",
"sq",
"be",
"bg",
"hr",
"cs",
"da",
"et",
"fi",
"el",
"hu",
"is",
"ga",
"lv",
"lt",
"mk",
"mt",
"no",
"pt",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"uk",
"cy"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
},
"viewSettings": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateVisibleColumns": [
"default_status",
"default_candidate"
],
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"signature": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"type": "upload",
"originalId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"blackId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"whiteId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | adminUserFindResponse |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
200 | X-CURRENT-PAGE | integer | Current page | |
200 | X-PAGE-OFFSET | integer | Current offset | |
200 | X-PAGE-LIMIT | integer | Current limit | |
200 | X-TOTAL-PAGES | integer | The total number of pages. | |
200 | X-TOTAL-RECORDS | integer | The total number of items. |
Create new admin user
Code samples
POST https://api.checkhub.io/adminUsers HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"isOwner": false,
"password": "6kgiWMzhKD0IPzRS"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"isOwner": false,
"password": "6kgiWMzhKD0IPzRS"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/adminUsers', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/adminUsers',
params: {
}, headers: headers
p JSON.parse(result)
POST /adminUsers
Body parameter
{
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"isOwner": false,
"password": "6kgiWMzhKD0IPzRS"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
gender | body | adminUserGender | false | Admin User Gender |
firstName | body | string | true | Admin User First Name |
lastName | body | string | true | Admin User Last Name |
body | string | true | Admin User Email address | |
phone | body | string | false | Admin User Phone |
position | body | string | false | Admin User Position |
language | body | adminUserLanguage | false | Admin User language |
forceChangePassword | body | boolean | false | Enable password force change |
isOwner | body | boolean | false | Is owner of company |
password | body | string | true | Admin User Password |
Enumerated Values
Parameter | Value |
---|---|
gender | |
gender | male |
gender | female |
language | en |
language | fr |
language | nl |
language | de |
language | it |
language | pl |
language | ro |
language | sq |
language | be |
language | bg |
language | hr |
language | cs |
language | da |
language | et |
language | fi |
language | el |
language | hu |
language | is |
language | ga |
language | lv |
language | lt |
language | mk |
language | mt |
language | no |
language | pt |
language | ru |
language | sr |
language | sk |
language | sl |
language | es |
language | sv |
language | uk |
language | cy |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"lastActivityAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"isOwner": false
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | adminUser |
Get admin user by {{id}}
Code samples
GET https://api.checkhub.io/adminUsers/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/adminUsers/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/adminUsers/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /adminUsers/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
includeSignature | query | boolean | false | To include admin user 'signature' relation |
includeSignatureOriginal | query | boolean | false | To include admin user 'signature' relation 'original' relation |
includeSignatureBlack | query | boolean | false | To include admin user 'signature' relation 'black' relation |
includeSignatureWhite | query | boolean | false | To include admin user 'signature' relation 'white' relation |
includeCompany | query | boolean | false | To include admin user 'company' relation |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"lastActivityAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"isOwner": false,
"company": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it",
"pl",
"ro",
"sq",
"be",
"bg",
"hr",
"cs",
"da",
"et",
"fi",
"el",
"hu",
"is",
"ga",
"lv",
"lt",
"mk",
"mt",
"no",
"pt",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"uk",
"cy"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
},
"viewSettings": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateVisibleColumns": [
"default_status",
"default_candidate"
],
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"signature": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"type": "upload",
"originalId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"blackId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"whiteId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | adminUserFindByIdResponse |
Update admin user by id
Code samples
PATCH https://api.checkhub.io/adminUsers/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"isOwner": false,
"newPassword": "6kgiWMzhKD0IPzRS"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers/{id}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"isOwner": false,
"newPassword": "6kgiWMzhKD0IPzRS"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers/{id}',
{
method: 'PATCH',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.patch('https://api.checkhub.io/adminUsers/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.patch 'https://api.checkhub.io/adminUsers/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /adminUsers/{id}
Body parameter
{
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"isOwner": false,
"newPassword": "6kgiWMzhKD0IPzRS"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be updated |
gender | body | adminUserGender | false | Admin User Gender |
firstName | body | string | false | Admin User First Name |
lastName | body | string | false | Admin User Last Name |
body | string | false | Admin User Email address | |
phone | body | string | false | Admin User Phone |
position | body | string | false | Admin User Position |
language | body | adminUserLanguage | false | Admin User language |
forceChangePassword | body | boolean | false | Enable password force change |
isOwner | body | boolean | false | Is owner of company |
newPassword | body | string | false | New password for the user |
Enumerated Values
Parameter | Value |
---|---|
gender | |
gender | male |
gender | female |
language | en |
language | fr |
language | nl |
language | de |
language | it |
language | pl |
language | ro |
language | sq |
language | be |
language | bg |
language | hr |
language | cs |
language | da |
language | et |
language | fi |
language | el |
language | hu |
language | is |
language | ga |
language | lv |
language | lt |
language | mk |
language | mt |
language | no |
language | pt |
language | ru |
language | sr |
language | sk |
language | sl |
language | es |
language | sv |
language | uk |
language | cy |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"lastActivityAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"isOwner": false
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | adminUser |
Delete admin user by id
Code samples
DELETE https://api.checkhub.io/adminUsers/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.delete('https://api.checkhub.io/adminUsers/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.delete 'https://api.checkhub.io/adminUsers/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /adminUsers/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be deleted |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | successfullyCompletedRequest |
Get access token for admin user
Code samples
POST https://api.checkhub.io/adminUsers/login HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"email": "[email protected]",
"password": "eTmESlA3000"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers/login',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"email": "[email protected]",
"password": "eTmESlA3000"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers/login',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/adminUsers/login', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/adminUsers/login',
params: {
}, headers: headers
p JSON.parse(result)
POST /adminUsers/login
Body parameter
{
"email": "[email protected]",
"password": "eTmESlA3000"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
body | string | false | Admin user email | |
password | body | string | false | Admin user password |
Example responses
200 Response
{
"id": "TDzlHHx590XulC7KygP4MIo6BQGg2QKMO3UvEvwEtNssGISZ43FrRUmt2XzbxkOY",
"ttl": 43200,
"created": "2019-09-12T15:36:09.264Z",
"userId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | accessToken |
Delete access token for current admin user
Code samples
POST https://api.checkhub.io/adminUsers/logout HTTP/1.1
Host: api.checkhub.io
const headers = {
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers/logout',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers/logout',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Authorization': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/adminUsers/logout', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/adminUsers/logout',
params: {
}, headers: headers
p JSON.parse(result)
POST /adminUsers/logout
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Request was successful | None |
Get current admin user info
Code samples
GET https://api.checkhub.io/adminUsers/me/info HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers/me/info',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers/me/info',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/adminUsers/me/info', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/adminUsers/me/info',
params: {
}, headers: headers
p JSON.parse(result)
GET /adminUsers/me/info
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
includeAcl | query | boolean | false | To include admin user info 'acl' with allowed acl settings |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"lastActivityAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"isOwner": false,
"elevioUserHash": "828caxxxxxxx4cdde",
"elevioGroups": [],
"elevioTraits": [],
"acl": {
"conditions": [
{
"acl": {
"accountIds": [
"string"
],
"isAllAccounts": true,
"onlyRelatedCandidates": true,
"availableTagIds": [
"string"
],
"isAllAvailableTags": true,
"restrictedTagIds": [
"string"
],
"restrictedTagsCondition": "or",
"isAllRestrictedTags": true,
"rights": [
"candidateCreate",
"candidateView"
]
}
}
],
"rights": [
"candidateCreate",
"candidateView"
]
},
"company": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it",
"pl",
"ro",
"sq",
"be",
"bg",
"hr",
"cs",
"da",
"et",
"fi",
"el",
"hu",
"is",
"ga",
"lv",
"lt",
"mk",
"mt",
"no",
"pt",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"uk",
"cy"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
},
"viewSettings": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateVisibleColumns": [
"default_status",
"default_candidate"
],
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"signature": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"type": "upload",
"originalId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"blackId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"whiteId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | adminUserGetInfoResponse |
Change admin user password
Code samples
PUT https://api.checkhub.io/adminUsers/me/change-password HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"password": "1xzoJz1mGIMplacy",
"newPassword": "MxUVl7a3iPyuWR4s",
"confirmPassword": "MxUVl7a3iPyuWR4s"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers/me/change-password',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"password": "1xzoJz1mGIMplacy",
"newPassword": "MxUVl7a3iPyuWR4s",
"confirmPassword": "MxUVl7a3iPyuWR4s"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers/me/change-password',
{
method: 'PUT',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.put('https://api.checkhub.io/adminUsers/me/change-password', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.put 'https://api.checkhub.io/adminUsers/me/change-password',
params: {
}, headers: headers
p JSON.parse(result)
PUT /adminUsers/me/change-password
Body parameter
{
"password": "1xzoJz1mGIMplacy",
"newPassword": "MxUVl7a3iPyuWR4s",
"confirmPassword": "MxUVl7a3iPyuWR4s"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
password | body | string | false | Current password |
newPassword | body | string | false | New password |
confirmPassword | body | string | false | Confirm new password |
Example responses
200 Response
{
"isPasswordChanged": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | adminUserChangePasswordResponse |
Check uniqueness of the email
Code samples
POST https://api.checkhub.io/adminUsers/checkEmail HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"email": "[email protected]",
"ownId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers/checkEmail',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"email": "[email protected]",
"ownId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUsers/checkEmail',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/adminUsers/checkEmail', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/adminUsers/checkEmail',
params: {
}, headers: headers
p JSON.parse(result)
POST /adminUsers/checkEmail
Body parameter
{
"email": "[email protected]",
"ownId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
body | string | true | Email to check | |
ownId | body | UUID_V4 | false | Unique identifier for the entity |
Example responses
200 Response
{
"isUnique": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | adminUserCheckEmailResponse |
Admin User Signature
Get admin user signature collection
Code samples
GET https://api.checkhub.io/admin-user-signatures HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/admin-user-signatures',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/admin-user-signatures',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/admin-user-signatures', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/admin-user-signatures',
params: {
}, headers: headers
p JSON.parse(result)
GET /admin-user-signatures
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response. min: 1 , max: 100 , default: 10 |
skip | query | number | false | Number of items skipped during the selection. min: 0 , default: 0 |
order | query | string | false | Admin User Signature collection order |
filter[adminUserId] | query | UUID_V4 | false | Search by admin user signature adminUserId |
includeOriginal | query | boolean | false | To include admin user signature 'original' relation |
includeBlack | query | boolean | false | To include admin user signature 'black' relation |
includeWhite | query | boolean | false | To include admin user signature 'white' relation |
Enumerated Values
Parameter | Value |
---|---|
order | createdAt asc |
order | createdAt desc |
order | updatedAt asc |
order | updatedAt desc |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"type": "upload",
"originalId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"blackId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"whiteId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"original": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
},
"black": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
},
"white": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
}
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | adminUserSignatureFindResponse |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
200 | X-CURRENT-PAGE | integer | Current page | |
200 | X-PAGE-OFFSET | integer | Current offset | |
200 | X-PAGE-LIMIT | integer | Current limit | |
200 | X-TOTAL-PAGES | integer | The total number of pages. | |
200 | X-TOTAL-RECORDS | integer | The total number of items. |
Get admin user signature by {{id}}
Code samples
GET https://api.checkhub.io/admin-user-signatures/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/admin-user-signatures/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/admin-user-signatures/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/admin-user-signatures/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/admin-user-signatures/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /admin-user-signatures/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
includeOriginal | query | boolean | false | To include admin user signature 'original' relation |
includeBlack | query | boolean | false | To include admin user signature 'black' relation |
includeWhite | query | boolean | false | To include admin user signature 'white' relation |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"type": "upload",
"originalId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"blackId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"whiteId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"original": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
},
"black": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
},
"white": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | adminUserSignatureFindByIdResponse |
Update admin user signature by id
Code samples
PATCH https://api.checkhub.io/admin-user-signatures/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"type": "upload",
"originalId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"blackId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"whiteId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/admin-user-signatures/{id}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"type": "upload",
"originalId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"blackId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"whiteId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/admin-user-signatures/{id}',
{
method: 'PATCH',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.patch('https://api.checkhub.io/admin-user-signatures/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.patch 'https://api.checkhub.io/admin-user-signatures/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /admin-user-signatures/{id}
Body parameter
{
"type": "upload",
"originalId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"blackId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"whiteId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be updated |
type | body | string | false | Signature type |
originalId | body | UUID_V4 | false | Unique identifier for the entity |
blackId | body | UUID_V4 | false | Unique identifier for the entity |
whiteId | body | UUID_V4 | false | Unique identifier for the entity |
Enumerated Values
Parameter | Value |
---|---|
type | draw |
type | upload |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"type": "upload",
"originalId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"blackId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"whiteId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | adminUserSignature |
Admin User Group
Get admin user group collection
Code samples
GET https://api.checkhub.io/adminUserGroups HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUserGroups',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUserGroups',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/adminUserGroups', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/adminUserGroups',
params: {
}, headers: headers
p JSON.parse(result)
GET /adminUserGroups
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response. min: 1 , max: 100 , default: 10 |
skip | query | number | false | Number of items skipped during the selection. min: 0 , default: 0 |
order | query | string | false | Admin user group collection order |
filter[name] | query | string | false | Search by admin user group name |
includeRestrictedTags | query | boolean | false | To include admin user group 'restrictedTags' relation |
includeRestrictedTagsTag | query | boolean | false | To include admin user group 'restrictedTags' relation with embedded 'tag' relation |
includeAvailableTags | query | boolean | false | To include admin user group 'availableTags' relation |
includeAvailableTagsTag | query | boolean | false | To include admin user group 'availableTags' relation with embedded 'tag' relation |
Enumerated Values
Parameter | Value |
---|---|
order | name asc |
order | name desc |
order | createdAt asc |
order | createdAt desc |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isMain": false,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "First-line managers",
"reference": "First-line managers",
"adminUsers": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"adminUserRights": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllAccounts": false,
"restrictedTagsCondition": "or",
"onlyRelatedCandidates": true,
"availableTags": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
],
"restrictedTags": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | adminUserGroupFindResponse |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
200 | X-CURRENT-PAGE | integer | Current page | |
200 | X-PAGE-OFFSET | integer | Current offset | |
200 | X-PAGE-LIMIT | integer | Current limit | |
200 | X-TOTAL-PAGES | integer | The total number of pages. | |
200 | X-TOTAL-RECORDS | integer | The total number of items. |
Create new admin user group
Code samples
POST https://api.checkhub.io/adminUserGroups HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"name": "First-line managers",
"reference": "First-line managers",
"adminUsers": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"adminUserRights": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllAccounts": false,
"restrictedTagsCondition": "or",
"onlyRelatedCandidates": true,
"availableTags": [],
"restrictedTags": []
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUserGroups',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"name": "First-line managers",
"reference": "First-line managers",
"adminUsers": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"adminUserRights": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllAccounts": false,
"restrictedTagsCondition": "or",
"onlyRelatedCandidates": true,
"availableTags": [],
"restrictedTags": []
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUserGroups',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/adminUserGroups', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/adminUserGroups',
params: {
}, headers: headers
p JSON.parse(result)
POST /adminUserGroups
Body parameter
{
"name": "First-line managers",
"reference": "First-line managers",
"adminUsers": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"adminUserRights": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllAccounts": false,
"restrictedTagsCondition": "or",
"onlyRelatedCandidates": true,
"availableTags": [],
"restrictedTags": []
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
name | body | string | true | Admin user group name |
reference | body | string | false | Admin user group reference |
adminUsers | body | [UUID_V4] | false | Array of admin users ids related to this group |
adminUserRights | body | [UUID_V4] | true | Array of admin user rights related to this group |
accounts | body | [UUID_V4] | false | Array of accounts for which admin users have access and the specified rights apply. |
isAllAccounts | body | boolean | false | Admin users in this group will have the assigned rights for all company accounts. |
restrictedTagsCondition | body | adminUserGroupRestrictedTagsCondition | false | none |
onlyRelatedCandidates | body | boolean | false | Admin users in this group will have the assigned rights for candidates they have created or candidates that have been assigned to them. |
availableTags | body | [UUID_V4] | false | Array of tag ids |
restrictedTags | body | [UUID_V4] | false | Array of tag ids |
Enumerated Values
Parameter | Value |
---|---|
restrictedTagsCondition | or |
restrictedTagsCondition | and |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isMain": false,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "First-line managers",
"reference": "First-line managers",
"adminUsers": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"adminUserRights": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllAccounts": false,
"restrictedTagsCondition": "or",
"onlyRelatedCandidates": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | adminUserGroup |
Get admin user group by {{id}}
Code samples
GET https://api.checkhub.io/adminUserGroups/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUserGroups/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUserGroups/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/adminUserGroups/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/adminUserGroups/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /adminUserGroups/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
includeRestrictedTags | query | boolean | false | To include admin user group 'restrictedTags' relation |
includeRestrictedTagsTag | query | boolean | false | To include admin user group 'restrictedTags' relation with embedded 'tag' relation |
includeAvailableTags | query | boolean | false | To include admin user group 'availableTags' relation |
includeAvailableTagsTag | query | boolean | false | To include admin user group 'availableTags' relation with embedded 'tag' relation |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isMain": false,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "First-line managers",
"reference": "First-line managers",
"adminUsers": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"adminUserRights": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllAccounts": false,
"restrictedTagsCondition": "or",
"onlyRelatedCandidates": true,
"availableTags": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
],
"restrictedTags": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | adminUserGroupFindByIdResponse |
Update admin user group by id
Code samples
PATCH https://api.checkhub.io/adminUserGroups/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"name": "First-line managers",
"reference": "First-line managers",
"adminUsers": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"adminUserRights": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllAccounts": false,
"restrictedTagsCondition": "or",
"onlyRelatedCandidates": true,
"availableTags": [],
"restrictedTags": []
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUserGroups/{id}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"name": "First-line managers",
"reference": "First-line managers",
"adminUsers": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"adminUserRights": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllAccounts": false,
"restrictedTagsCondition": "or",
"onlyRelatedCandidates": true,
"availableTags": [],
"restrictedTags": []
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUserGroups/{id}',
{
method: 'PATCH',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.patch('https://api.checkhub.io/adminUserGroups/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.patch 'https://api.checkhub.io/adminUserGroups/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /adminUserGroups/{id}
Body parameter
{
"name": "First-line managers",
"reference": "First-line managers",
"adminUsers": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"adminUserRights": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllAccounts": false,
"restrictedTagsCondition": "or",
"onlyRelatedCandidates": true,
"availableTags": [],
"restrictedTags": []
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be updated |
name | body | string | false | Admin user group name |
reference | body | string | false | Admin user group reference |
adminUsers | body | [UUID_V4] | false | Array of admin users ids related to this group |
adminUserRights | body | [UUID_V4] | false | Array of admin user rights related to this group |
accounts | body | [UUID_V4] | false | Array of accounts for which admin users have access and the specified rights apply. |
isAllAccounts | body | boolean | false | Admin users in this group will have the assigned rights for all company accounts. |
restrictedTagsCondition | body | adminUserGroupRestrictedTagsCondition | false | none |
onlyRelatedCandidates | body | boolean | false | Admin users in this group will have the assigned rights for candidates they have created or candidates that have been assigned to them. |
availableTags | body | [UUID_V4] | false | Array of tag ids |
restrictedTags | body | [UUID_V4] | false | Array of tag ids |
Enumerated Values
Parameter | Value |
---|---|
restrictedTagsCondition | or |
restrictedTagsCondition | and |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isMain": false,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "First-line managers",
"reference": "First-line managers",
"adminUsers": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"adminUserRights": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllAccounts": false,
"restrictedTagsCondition": "or",
"onlyRelatedCandidates": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | adminUserGroup |
Delete admin user group by id
Code samples
DELETE https://api.checkhub.io/adminUserGroups/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUserGroups/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUserGroups/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.delete('https://api.checkhub.io/adminUserGroups/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.delete 'https://api.checkhub.io/adminUserGroups/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /adminUserGroups/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be deleted |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | successfullyCompletedRequest |
Admin User Right
Get admin user right collection
Code samples
GET https://api.checkhub.io/adminUserRights HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUserRights',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUserRights',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/adminUserRights', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/adminUserRights',
params: {
}, headers: headers
p JSON.parse(result)
GET /adminUserRights
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response. min: 1 , max: 100 , default: 10 |
skip | query | number | false | Number of items skipped during the selection. min: 0 , default: 0 |
order | query | string | false | Admin user right collection order |
filter[name] | query | string | false | Search by admin user right name |
filter[label] | query | string | false | Search by admin user right label |
filter[searchText] | query | string | false | Search by admin user right label/name free text |
Enumerated Values
Parameter | Value |
---|---|
order | name asc |
order | name desc |
order | label asc |
order | label desc |
filter[name] | accountManagement |
filter[name] | candidateCreate |
filter[name] | candidateDelete |
filter[name] | candidateEdit |
filter[name] | candidateImport |
filter[name] | candidateView |
filter[name] | companySettings |
filter[name] | customFieldManagement |
filter[name] | documentTypeManagement |
filter[name] | documentTypeValidationManagement |
filter[name] | mergeSetManagement |
filter[name] | notificationManagement |
filter[name] | policiesManagement |
filter[name] | presetManagement |
filter[name] | resourceManagement |
filter[name] | superAdmin |
filter[name] | tagManagement |
filter[name] | themeManagement |
filter[name] | userCreate |
filter[name] | userGroupManagement |
filter[name] | userResetPassword |
filter[name] | formManagement |
filter[name] | signatureManagement |
filter[name] | registrationPageManagement |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "notificationManagement",
"label": "Access to Notification Management"
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | adminUserRightFindResponse |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
200 | X-CURRENT-PAGE | integer | Current page | |
200 | X-PAGE-OFFSET | integer | Current offset | |
200 | X-PAGE-LIMIT | integer | Current limit | |
200 | X-TOTAL-PAGES | integer | The total number of pages. | |
200 | X-TOTAL-RECORDS | integer | The total number of items. |
Get admin user right by {{id}}
Code samples
GET https://api.checkhub.io/adminUserRights/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUserRights/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/adminUserRights/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/adminUserRights/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/adminUserRights/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /adminUserRights/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "notificationManagement",
"label": "Access to Notification Management"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | adminUserRightFindByIdResponse |
Candidate
Create a new Candidate.
Code samples
POST https://api.checkhub.io/candidates HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "+3801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"customFields": [
{
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "custom_value"
}
],
"tagIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"presetIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"presetReferences": [
"preset_ref_1",
"preset_ref_2"
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "+3801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"customFields": [
{
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "custom_value"
}
],
"tagIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"presetIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"presetReferences": [
"preset_ref_1",
"preset_ref_2"
]
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/candidates', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/candidates',
params: {
}, headers: headers
p JSON.parse(result)
POST /candidates
Body parameter
{
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "+3801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"customFields": [
{
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "custom_value"
}
],
"tagIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"presetIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"presetReferences": [
"preset_ref_1",
"preset_ref_2"
]
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
accountId | body | UUID_V4 | true | Unique identifier for the entity |
body | string | true | Candidate Email address | |
firstName | body | string | true | User First Name |
lastName | body | string | true | User Last Name |
reference | body | string | false | Candidate reference |
language | body | language | true | none |
welcomeText | body | string | false | Welcome text for the candidate. (only if type 'custom' is selected) |
welcomeTextType | body | string | false | Welcome text type |
assigneeId | body | UUID_V4 | false | Unique identifier for the entity |
additionalEmails | body | [string] | false | Candidate additional emails. Not more than 5 emails |
snoozed | body | boolean | false | Turns off future notifications (email and SMS) to this candidate |
mobilePhone | body | string | false | User mobile phone number in the international format |
notes | body | string | false | Candidate additional notes |
deadline | body | DateISO(date-time) | false | Datetime in ISO format |
customFields | body | [candidateCreateCustomField] | false | Custom fields that will be applied to the candidate during creation. |
» customFieldId | body | UUID_V4 | false | Unique identifier for the entity |
» value | body | string | false | Custom field value |
tagIds | body | [UUID_V4] | false | Tags that will be applied to the candidate during creation. |
presetIds | body | [UUID_V4] | false | Candidate preset ids |
presetReferences | body | [string] | false | Candidate preset references |
Enumerated Values
Parameter | Value |
---|---|
language | en |
language | fr |
language | nl |
language | de |
language | it |
language | pl |
language | ro |
language | sq |
language | be |
language | bg |
language | hr |
language | cs |
language | da |
language | et |
language | fi |
language | el |
language | hu |
language | is |
language | ga |
language | lv |
language | lt |
language | mk |
language | mt |
language | no |
language | pt |
language | ru |
language | sr |
language | sk |
language | sl |
language | es |
language | sv |
language | uk |
language | cy |
welcomeTextType | default |
welcomeTextType | custom |
welcomeTextType | none |
Example responses
200 Response
{
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidate |
Get candidates collection matched by query params.
Code samples
GET https://api.checkhub.io/candidates HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/candidates', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/candidates',
params: {
}, headers: headers
p JSON.parse(result)
GET /candidates
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response. min: 1 , max: 100 , default: 10 |
skip | query | number | false | Number of items skipped during the selection. min: 0 , default: 0 |
order | query | string | false | Candidates order |
filter[reference] | query | string | false | Filter by candidate 'reference' field |
filter[references][] | query | string | false | Filter result by candidate references (or) |
filter[email] | query | string | false | Filter by candidate 'email' field |
filter[emails][] | query | string | false | Filter result by candidate emails (or) |
filter[firstName] | query | string | false | Filter by candidate 'firstName' field |
filter[lastName] | query | string | false | Filter by candidate 'lastName' field |
filter[archived] | query | boolean | false | Filter by candidate 'archived' field |
filter[accountId] | query | UUID_V4 | false | Filter by candidate 'accountId' field |
filter[accountIds][] | query | UUID_V4 | false | Filter by candidate 'accountIds' field |
filter[tagIds][] | query | UUID_V4 | false | Filter by candidate related tag ids |
filter[withoutTagIds][] | query | UUID_V4 | false | Filter by candidate without tag ids |
filter[searchText] | query | string | false | Search result by following properties: ('email', 'firstName', 'lastName', 'notes', 'reference', 'candidateCustomField.value') |
filter[statuses][] | query | candidateStatus | false | Filter result by custom statuses (or) |
filter[comments] | query | candidateCommentsFilter | false | Filter result by comments |
filter[assigneeId] | query | UUID_V4 | false | Filter by candidate 'assigneeId' field |
filter[assigneeId][] | query | UUID_V4 | false | Filter by candidate 'assigneeIds' field |
filter[isAssigned] | query | boolean | false | Filter by 'isAssigned' candidate |
includeAccount | query | boolean | false | You can include candidate 'account' relation |
includeUser | query | boolean | false | You can include candidate 'user' relation |
includeChecks | query | boolean | false | You can include candidate 'checks' relation |
includeDocumentStatistic | query | boolean | false | You can include candidate 'documentStatistic' relation |
includeCandidateDocumentTypes | query | boolean | false | You can include candidate 'candidateDocumentTypes' relation |
includeResources | query | boolean | false | You can include candidate 'resources' relation |
includeForms | query | boolean | false | You can include candidate 'forms' relation |
includeFormsData | query | boolean | false | You can include candidate forms with included form 'data' relation |
includeFormsAdditions | query | boolean | false | You can include candidate forms with included form 'additions' relation |
includeFormsAdditionsData | query | boolean | false | You can include candidate forms additions with included addition 'data' relation |
includeFormsAdditionsAttachments | query | boolean | false | You can include candidate forms additions with included addition 'attachments' relation |
includeFormsAdditionsAttachmentsWithFile | query | boolean | false | You can include candidate forms additions attachments with included attachment 'file' relation |
includeFormsAttachments | query | boolean | false | You can include candidate forms with included form 'attachments' relation |
includeFormsAttachmentsWithFile | query | boolean | false | You can include candidate forms attachments with included attachment 'file' relation |
includeFormsSignatureRequest | query | boolean | false | You can include candidate forms with included form 'signatureRequest' relation |
includeFormsSignatureRequestSigners | query | boolean | false | You can include candidate forms signatureRequest with included signatureRequest 'signers' relation |
includeFormsSignatureRequestSignersEntity | query | boolean | false | You can include candidate forms signatureRequest signers with included signer 'entity' relation |
includeFormsSignatureRequestSignature | query | boolean | false | You can include candidate forms signatureRequest with included signatureRequest 'signature' relation |
includeConversation | query | boolean | false | You can include candidate 'conversation' relation |
includeCustomFields | query | boolean | false | You can include candidate 'customFields' relation |
includeTags | query | boolean | false | You can include candidate 'tags' relation |
includeAssignee | query | boolean | false | You can include candidate 'assignee' relation |
includeSelfie | query | boolean | false | You can include candidate 'selfie' relation |
includeSelfieFront | query | boolean | false | You can include candidate 'selfie' relation with embedded 'front' relation |
includeSelfieFrontThumbnail | query | boolean | false | You can include candidate 'selfie' relation with embedded 'frontThumbnail' relation |
Enumerated Values
Parameter | Value |
---|---|
order | candidate.createdAt asc |
order | candidate.createdAt desc |
order | candidate.updatedAt asc |
order | candidate.updatedAt desc |
order | candidate.lastName asc |
order | candidate.lastName desc |
order | candidate.deadline asc |
order | candidate.deadline desc |
order | custom_field_order.value.{customFieldId} |
filter[statuses][] | open |
filter[statuses][] | pending |
filter[statuses][] | completed |
filter[statuses][] | rejected |
filter[comments] | all |
filter[comments] | unread |
Example responses
200 Response
[
{
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"account": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"aboutText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedBoxText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"company": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it",
"pl",
"ro",
"sq",
"be",
"bg",
"hr",
"cs",
"da",
"et",
"fi",
"el",
"hu",
"is",
"ga",
"lv",
"lt",
"mk",
"mt",
"no",
"pt",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"uk",
"cy"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
},
"documentStatistic": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"docRequestedTotal": 7,
"docProvidedTotal": 6,
"docMandatoryRequestedTotal": 4,
"docMandatoryProvidedTotal": 4,
"docOptionalRequestedTotal": 3,
"docOptionalProvidedTotal": 2,
"resourceTotal": 5,
"resourceCompletedTotal": 2,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"conversation": null,
"customFields": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "1234-456-32"
}
],
"user": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"lastActivityAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"isOwner": false
},
"tags": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z"
}
],
"resources": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Manager's contract",
"locked": false,
"text": "<p>It's the contract.</p>",
"completedActions": [
"complete",
"download"
],
"file": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"filename": "Contract J.J. Mask.pdf",
"remoteFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFilename": "Contract_example.pdf",
"fields": [
{
"reference": "Mask",
"value": {
"checkbox": false,
"text": "Mask",
"email": "Mask",
"signature": "data:image/png;base64,iVBORw0KGg"
}
}
],
"status": "requested",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies"
}
],
"candidateDocumentTypes": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"internal": false,
"folder": "string",
"customStatus": "pending",
"ocrParsedData": {},
"validationSnapshot": {
"total": 10,
"totalToBePending": 10,
"conditions": [
{
"type": "or",
"action": "score",
"score": 10,
"sequence": 1,
"isValid": true,
"validations": [
{
"rule": "string",
"method": "contains",
"value": {
"value": "value"
},
"fieldName": "firstName",
"fieldValue": "Field value",
"sequence": 1,
"isValid": true
}
]
}
]
},
"integrationTransferedAt": "string",
"mergeSetFilePath": "string",
"isMultiple": false,
"isProcessing": false,
"isPaused": false,
"combinedMultipleDocumentPath": "string",
"combinedMultipleDocumentName": "string",
"expiresOn": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false
}
]
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateFindResponse |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
200 | X-CURRENT-PAGE | integer | Current page | |
200 | X-PAGE-OFFSET | integer | Current offset | |
200 | X-PAGE-LIMIT | integer | Current limit | |
200 | X-TOTAL-PAGES | integer | The total number of pages. | |
200 | X-TOTAL-RECORDS | integer | The total number of items. |
Delete Candidates
Code samples
DELETE https://api.checkhub.io/candidates HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.delete('https://api.checkhub.io/candidates', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.delete 'https://api.checkhub.io/candidates',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /candidates
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
filter | query | candidateDeleteFilter | false | Delete Candidates filter params |
Example responses
200 Response
{
"count": 3
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateDeleteResponse |
Deleting a model instance by {{id}} from the data source.
Code samples
DELETE https://api.checkhub.io/candidates/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.delete('https://api.checkhub.io/candidates/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.delete 'https://api.checkhub.io/candidates/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /candidates/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be deleted |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Candidate is deleted | successfullyCompletedRequest |
Get candidate by {{id}} from the data source.
Code samples
GET https://api.checkhub.io/candidates/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/candidates/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/candidates/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /candidates/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
includeAccount | query | boolean | false | You can include candidate 'account' relation |
includeUser | query | boolean | false | You can include candidate 'user' relation |
includeChecks | query | boolean | false | You can include candidate 'checks' relation |
includeDocumentStatistic | query | boolean | false | You can include candidate 'documentStatistic' relation |
includeCandidateDocumentTypes | query | boolean | false | You can include candidate 'candidateDocumentTypes' relation |
includeResources | query | boolean | false | You can include candidate 'resources' relation |
includeForms | query | boolean | false | You can include candidate 'forms' relation |
includeFormsData | query | boolean | false | You can include candidate forms with included form 'data' relation |
includeFormsAdditions | query | boolean | false | You can include candidate forms with included form 'additions' relation |
includeFormsAdditionsData | query | boolean | false | You can include candidate forms additions with included addition 'data' relation |
includeFormsAdditionsAttachments | query | boolean | false | You can include candidate forms additions with included addition 'attachments' relation |
includeFormsAdditionsAttachmentsWithFile | query | boolean | false | You can include candidate forms additions attachments with included attachment 'file' relation |
includeFormsAttachments | query | boolean | false | You can include candidate forms with included form 'attachments' relation |
includeFormsAttachmentsWithFile | query | boolean | false | You can include candidate forms attachments with included attachment 'file' relation |
includeFormsSignatureRequest | query | boolean | false | You can include candidate forms with included form 'signatureRequest' relation |
includeFormsSignatureRequestSigners | query | boolean | false | You can include candidate forms signatureRequest with included signatureRequest 'signers' relation |
includeFormsSignatureRequestSignersEntity | query | boolean | false | You can include candidate forms signatureRequest signers with included signer 'entity' relation |
includeFormsSignatureRequestSignature | query | boolean | false | You can include candidate forms signatureRequest with included signatureRequest 'signature' relation |
includeConversation | query | boolean | false | You can include candidate 'conversation' relation |
includeCustomFields | query | boolean | false | You can include candidate 'customFields' relation |
includeTags | query | boolean | false | You can include candidate 'tags' relation |
includeAssignee | query | boolean | false | You can include candidate 'assignee' relation |
includeSelfie | query | boolean | false | You can include candidate 'selfie' relation |
includeSelfieFront | query | boolean | false | You can include candidate 'selfie' relation with embedded 'front' relation |
includeSelfieFrontThumbnail | query | boolean | false | You can include candidate 'selfie' relation with embedded 'frontThumbnail' relation |
Example responses
200 Response
{
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"account": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"aboutText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedBoxText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"company": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it",
"pl",
"ro",
"sq",
"be",
"bg",
"hr",
"cs",
"da",
"et",
"fi",
"el",
"hu",
"is",
"ga",
"lv",
"lt",
"mk",
"mt",
"no",
"pt",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"uk",
"cy"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
},
"documentStatistic": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"docRequestedTotal": 7,
"docProvidedTotal": 6,
"docMandatoryRequestedTotal": 4,
"docMandatoryProvidedTotal": 4,
"docOptionalRequestedTotal": 3,
"docOptionalProvidedTotal": 2,
"resourceTotal": 5,
"resourceCompletedTotal": 2,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"conversation": null,
"customFields": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "1234-456-32"
}
],
"user": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"lastActivityAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"isOwner": false
},
"tags": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z"
}
],
"resources": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Manager's contract",
"locked": false,
"text": "<p>It's the contract.</p>",
"completedActions": [
"complete",
"download"
],
"file": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"filename": "Contract J.J. Mask.pdf",
"remoteFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFilename": "Contract_example.pdf",
"fields": [
{
"reference": "Mask",
"value": {
"checkbox": false,
"text": "Mask",
"email": "Mask",
"signature": "data:image/png;base64,iVBORw0KGg"
}
}
],
"status": "requested",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies"
}
],
"candidateDocumentTypes": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"internal": false,
"folder": "string",
"customStatus": "pending",
"ocrParsedData": {},
"validationSnapshot": {
"total": 10,
"totalToBePending": 10,
"conditions": [
{
"type": "or",
"action": "score",
"score": 10,
"sequence": 1,
"isValid": true,
"validations": [
{
"rule": "string",
"method": "contains",
"value": {
"value": "value"
},
"fieldName": "firstName",
"fieldValue": "Field value",
"sequence": 1,
"isValid": true
}
]
}
]
},
"integrationTransferedAt": "string",
"mergeSetFilePath": "string",
"isMultiple": false,
"isProcessing": false,
"isPaused": false,
"combinedMultipleDocumentPath": "string",
"combinedMultipleDocumentName": "string",
"expiresOn": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false
}
]
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateFindByIdResponse |
Edit candidate by {{id}}
Code samples
PATCH https://api.checkhub.io/candidates/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "<p>Hi!</p>>",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "+3801234567890",
"notes": "Some notes about candidate",
"deadline": "2019-09-12T15:36:09.264Z",
"archived": false,
"tagIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates/{id}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "<p>Hi!</p>>",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "+3801234567890",
"notes": "Some notes about candidate",
"deadline": "2019-09-12T15:36:09.264Z",
"archived": false,
"tagIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates/{id}',
{
method: 'PATCH',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.patch('https://api.checkhub.io/candidates/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.patch 'https://api.checkhub.io/candidates/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /candidates/{id}
Body parameter
{
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "<p>Hi!</p>>",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "+3801234567890",
"notes": "Some notes about candidate",
"deadline": "2019-09-12T15:36:09.264Z",
"archived": false,
"tagIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be updated |
accountId | body | UUID_V4 | true | Unique identifier for the entity |
body | string | true | Candidate Email address | |
firstName | body | string | true | User First Name |
lastName | body | string | true | User Last Name |
reference | body | string | true | Candidate reference |
language | body | language | true | none |
welcomeText | body | string | false | Candidate welcome text |
welcomeTextType | body | string | false | Candidate welcome type |
assigneeId | body | UUID_V4 | false | Unique identifier for the entity |
additionalEmails | body | [string] | false | Candidate additional emails. Not more than 5 emails |
snoozed | body | boolean | false | Turns off future notifications (email and SMS) to this candidate |
mobilePhone | body | string | false | User mobile phone number in the international format |
notes | body | string | false | Candidate additional notes |
deadline | body | DateISO(date-time) | false | Datetime in ISO format |
archived | body | boolean | false | Archive or Unarchive candidate |
tagIds | body | [UUID_V4] | false | Tags that will be applied to the candidate during update. |
Enumerated Values
Parameter | Value |
---|---|
language | en |
language | fr |
language | nl |
language | de |
language | it |
language | pl |
language | ro |
language | sq |
language | be |
language | bg |
language | hr |
language | cs |
language | da |
language | et |
language | fi |
language | el |
language | hu |
language | is |
language | ga |
language | lv |
language | lt |
language | mk |
language | mt |
language | no |
language | pt |
language | ru |
language | sr |
language | sk |
language | sl |
language | es |
language | sv |
language | uk |
language | cy |
welcomeTextType | default |
welcomeTextType | custom |
welcomeTextType | none |
Example responses
200 Response
{
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidate |
Export candidates
Code samples
GET https://api.checkhub.io/candidates/export HTTP/1.1
Host: api.checkhub.io
Accept: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
const headers = {
'Accept':'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates/export',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates/export',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/candidates/export', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/candidates/export',
params: {
}, headers: headers
p JSON.parse(result)
GET /candidates/export
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
filter[reference] | query | string | false | Filter by candidate 'reference' field |
filter[references][] | query | string | false | Filter result by candidate references (or) |
filter[email] | query | string | false | Filter by candidate 'email' field |
filter[emails][] | query | string | false | Filter result by candidate emails (or) |
filter[archived] | query | boolean | false | Filter by candidate 'archived' field |
filter[accountId] | query | UUID_V4 | false | Filter by candidate 'accountId' field |
filter[accountIds][] | query | UUID_V4 | false | Filter by candidate 'accountIds' field |
filter[tagIds][] | query | UUID_V4 | false | Filter by candidate related tag ids |
filter[withoutTagIds][] | query | UUID_V4 | false | Filter by candidate without tag ids |
filter[searchText] | query | string | false | Search result by following properties: ('email', 'firstName', 'lastName', 'notes', 'reference', 'candidateCustomField.value') |
filter[statuses][] | query | candidateStatus | false | Filter result by custom statuses (or) |
filter[comments] | query | candidateCommentsFilter | false | Filter result by comments |
filter[assigneeId] | query | UUID_V4 | false | Filter by candidate 'assigneeId' field |
filter[assigneeId][] | query | UUID_V4 | false | Filter by candidate 'assigneeIds' field |
filter[isAssigned] | query | boolean | false | Filter by 'isAssigned' candidate |
order | query | string | false | Candidates order |
Enumerated Values
Parameter | Value |
---|---|
filter[statuses][] | open |
filter[statuses][] | pending |
filter[statuses][] | completed |
filter[statuses][] | rejected |
filter[comments] | all |
filter[comments] | unread |
order | candidate.createdAt asc |
order | candidate.createdAt desc |
order | candidate.updatedAt asc |
order | candidate.updatedAt desc |
order | candidate.lastName asc |
order | candidate.lastName desc |
order | candidate.deadline asc |
order | candidate.deadline desc |
order | custom_field_order.value.{customFieldId} |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Export XLSX file with candidates | string |
Import candidates with some relations
Code samples
POST https://api.checkhub.io/candidates/bulk HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"mode": "immediately",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidates": [
{
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"reference": "j_good1991",
"language": "en",
"deadline": "2019-09-12T15:36:09.264Z",
"additionalEmails": [
"[email protected]"
],
"mobilePhone": "+3801234567890",
"preset": "preset_1, preset_2",
"tags": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"presetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFields": [
{
"reference": "string",
"value": "string"
}
]
}
],
"documents": [
{
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "string",
"description": "string",
"filename": "file_of_the_company_candidate_{candidateFirstName}",
"comment": "string",
"commentType": "info",
"mandatory": true,
"folder": "string"
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": true,
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
],
"resources": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
]
}
],
"tags": {
"create": [
"string"
],
"apply": [
"string"
]
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates/bulk',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"mode": "immediately",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidates": [
{
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"reference": "j_good1991",
"language": "en",
"deadline": "2019-09-12T15:36:09.264Z",
"additionalEmails": [
"[email protected]"
],
"mobilePhone": "+3801234567890",
"preset": "preset_1, preset_2",
"tags": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"presetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFields": [
{
"reference": "string",
"value": "string"
}
]
}
],
"documents": [
{
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "string",
"description": "string",
"filename": "file_of_the_company_candidate_{candidateFirstName}",
"comment": "string",
"commentType": "info",
"mandatory": true,
"folder": "string"
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": true,
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
],
"resources": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
]
}
],
"tags": {
"create": [
"string"
],
"apply": [
"string"
]
}
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates/bulk',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/candidates/bulk', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/candidates/bulk',
params: {
}, headers: headers
p JSON.parse(result)
POST /candidates/bulk
Body parameter
{
"mode": "immediately",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidates": [
{
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"reference": "j_good1991",
"language": "en",
"deadline": "2019-09-12T15:36:09.264Z",
"additionalEmails": [
"[email protected]"
],
"mobilePhone": "+3801234567890",
"preset": "preset_1, preset_2",
"tags": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"presetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFields": [
{
"reference": "string",
"value": "string"
}
]
}
],
"documents": [
{
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "string",
"description": "string",
"filename": "file_of_the_company_candidate_{candidateFirstName}",
"comment": "string",
"commentType": "info",
"mandatory": true,
"folder": "string"
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": true,
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
],
"resources": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
]
}
],
"tags": {
"create": [
"string"
],
"apply": [
"string"
]
}
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
mode | body | string | true | Import mode |
accountId | body | UUID_V4 | true | Unique identifier for the entity |
candidates | body | [candidateBulkCandidate] | true | Candidates data |
» firstName | body | string | true | User First Name |
» lastName | body | string | true | User Last Name |
body | string | true | Candidate Email address | |
» reference | body | string | false | Candidate reference |
» language | body | language | true | none |
» deadline | body | DateISO(date-time) | false | Datetime in ISO format |
» additionalEmails | body | [string] | false | Candidate additional emails. Not more than 5 emails |
» mobilePhone | body | string | false | User mobile phone number in the international format |
» preset | body | string | false | Presets references with ',' separator |
» tags | body | [UUID_V4] | false | Tags that will be applied to the candidate during creation. |
» presetId | body | UUID_V4 | false | Unique identifier for the entity |
» assigneeId | body | UUID_V4 | false | Unique identifier for the entity |
» customFields | body | [object] | false | Candidate custom fields |
»» reference | body | string | true | Custom field reference |
»» value | body | string | true | Custom field value |
documents | body | [candidateBulkDocument] | true | Candidate Documents data |
» documentTypeId | body | UUID_V4 | true | Unique identifier for the entity |
» name | body | string | false | Candidate Document Type name |
» description | body | string | false | Candidate Document Type description |
» filename | body | string | false | Candidate Document filename. It can include dynamic fields like {candidateFirstName} |
» comment | body | string | false | Candidate Document Type comment |
» commentType | body | candidateDocumentTypeCommentType | false | Candidate document type comment type |
» mandatory | body | boolean | true | It says that Candidate Document Type is mandatory or optional for the candidate |
» folder | body | string | false | Candidate Document Type files folder name |
forms | body | [candidateBulkForm] | false | Candidate Forms data |
» id | body | UUID_V4 | true | Unique identifier for the entity |
» actions | body | [formAction] | true | Form actions (at least one action required); Please note that allowable actions depend on the type of the original form:
|
» isMandatory | body | boolean | false | It says that form is mandatory or optional for the candidate. |
» signatureId | body | UUID_V4 | false | Unique identifier for the entity |
» fileId | body | UUID_V4 | false | Unique identifier for the entity |
resources | body | [candidateBulkResource] | true | Candidate resources data |
» id | body | UUID_V4 | true | Unique identifier for the entity |
» actions | body | [resourceAction] | true | Resource actions (at least one action required) |
tags | body | candidateBulkTags | false | none |
» create | body | [string] | true | New tag names |
» apply | body | [string] | true | Selected tag names |
Enumerated Values
Parameter | Value |
---|---|
mode | immediately |
mode | postponed |
» language | en |
» language | fr |
» language | nl |
» language | de |
» language | it |
» language | pl |
» language | ro |
» language | sq |
» language | be |
» language | bg |
» language | hr |
» language | cs |
» language | da |
» language | et |
» language | fi |
» language | el |
» language | hu |
» language | is |
» language | ga |
» language | lv |
» language | lt |
» language | mk |
» language | mt |
» language | no |
» language | pt |
» language | ru |
» language | sr |
» language | sk |
» language | sl |
» language | es |
» language | sv |
» language | uk |
» language | cy |
» commentType | info |
» commentType | success |
» commentType | warning |
» commentType | danger |
» actions | read |
» actions | complete |
» actions | eSign |
» actions | download |
» actions | read |
» actions | complete |
» actions | download |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"reference": "b_candidate100"
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateBulkResponse |
Reset candidate pending
Code samples
POST https://api.checkhub.io/candidates/{id}/reset-candidate-pending HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates/{id}/reset-candidate-pending',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates/{id}/reset-candidate-pending',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/candidates/{id}/reset-candidate-pending', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/candidates/{id}/reset-candidate-pending',
params: {
}, headers: headers
p JSON.parse(result)
POST /candidates/{id}/reset-candidate-pending
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Candidate reminder is reset | successfullyCompletedRequest |
Get candidate last activity
Code samples
GET https://api.checkhub.io/candidates/{id}/last-activity HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates/{id}/last-activity',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidates/{id}/last-activity',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/candidates/{id}/last-activity', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/candidates/{id}/last-activity',
params: {
}, headers: headers
p JSON.parse(result)
GET /candidates/{id}/last-activity
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
Example responses
200 Response
{
"email": {
"createdAt": "2019-09-12T15:36:09.264Z",
"target": "[email protected]",
"triggerType": "manually",
"templateName": "string",
"scenarioName": "string",
"scenarioEventName": "string",
"deliveryStatus": "string"
},
"sms": {
"createdAt": "2019-09-12T15:36:09.264Z",
"target": "00380506339231",
"triggerType": "manually",
"templateName": "string",
"scenarioName": "string",
"scenarioEventName": "string"
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateGetLastActivityResponse |
Candidate Token
Get candidate token collection
Code samples
GET https://api.checkhub.io/candidateTokens HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateTokens',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateTokens',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/candidateTokens', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/candidateTokens',
params: {
}, headers: headers
p JSON.parse(result)
GET /candidateTokens
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response. min: 1 , max: 100 , default: 10 |
skip | query | number | false | Number of items skipped during the selection. min: 0 , default: 0 |
order | query | string | false | Candidate Token collection order |
filter[validToken] | query | candidateTokenValid | false | Search by candidate token state |
filter[ids][] | query | UUID_V4 | false | Search by candidate token ids (or) |
filter[candidateId] | query | UUID_V4 | false | Search by candidate token candidateId |
includeCandidate | query | boolean | false | To include candidateToken 'candidate' relation |
Enumerated Values
Parameter | Value |
---|---|
order | createdAt asc |
order | createdAt desc |
order | validToken asc |
order | validToken desc |
order | candidateId asc |
order | candidateId desc |
order | tokenLink asc |
order | tokenLink desc |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"tokenLink": "1BlgIvCY20NjUXlRj",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validToken": true,
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateTokenFindResponse |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
200 | X-CURRENT-PAGE | integer | Current page | |
200 | X-PAGE-OFFSET | integer | Current offset | |
200 | X-PAGE-LIMIT | integer | Current limit | |
200 | X-TOTAL-PAGES | integer | The total number of pages. | |
200 | X-TOTAL-RECORDS | integer | The total number of items. |
Create candidate token
Code samples
POST https://api.checkhub.io/candidateTokens HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validToken": true
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateTokens',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validToken": true
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateTokens',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/candidateTokens', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/candidateTokens',
params: {
}, headers: headers
p JSON.parse(result)
POST /candidateTokens
Body parameter
{
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validToken": true
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
candidateId | body | UUID_V4 | true | Unique identifier for the entity |
validToken | body | candidateTokenValid | false | Is valid candidate token |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"tokenLink": "1BlgIvCY20NjUXlRj",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validToken": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateToken |
Get candidate token by {{id}}
Code samples
GET https://api.checkhub.io/candidateTokens/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateTokens/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateTokens/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/candidateTokens/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/candidateTokens/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /candidateTokens/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
includeCandidate | query | boolean | false | To include candidateToken 'candidate' relation |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"tokenLink": "1BlgIvCY20NjUXlRj",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validToken": true,
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateTokenFindByIdResponse |
Update candidate token by {{id}}
Code samples
PATCH https://api.checkhub.io/candidateTokens/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"validToken": true
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateTokens/{id}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"validToken": true
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateTokens/{id}',
{
method: 'PATCH',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.patch('https://api.checkhub.io/candidateTokens/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.patch 'https://api.checkhub.io/candidateTokens/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /candidateTokens/{id}
Body parameter
{
"validToken": true
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be updated |
validToken | body | candidateTokenValid | false | Is valid candidate token |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"tokenLink": "1BlgIvCY20NjUXlRj",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validToken": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateToken |
Delete candidate token by {{id}}
Code samples
DELETE https://api.checkhub.io/candidateTokens/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateTokens/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateTokens/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.delete('https://api.checkhub.io/candidateTokens/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.delete 'https://api.checkhub.io/candidateTokens/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /candidateTokens/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be deleted |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | successfullyCompletedRequest |
Get candidate token by {{link}}
Code samples
GET https://api.checkhub.io/candidateTokens/link/:link HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateTokens/link/:link',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateTokens/link/:link',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/candidateTokens/link/:link', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/candidateTokens/link/:link',
params: {
}, headers: headers
p JSON.parse(result)
GET /candidateTokens/link/:link
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
link | path | string | true | Token link |
Example responses
200 Response
{
"token": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateTokenFindByLinkResponse |
Candidate Tag
Remove tags from the candidate.
Code samples
DELETE https://api.checkhub.io/candidateTags/{candidateId} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '[
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateTags/{candidateId}',
{
method: 'DELETE',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
];
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateTags/{candidateId}',
{
method: 'DELETE',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.delete('https://api.checkhub.io/candidateTags/{candidateId}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.delete 'https://api.checkhub.io/candidateTags/{candidateId}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /candidateTags/{candidateId}
Body parameter
[
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
candidateId | path | UUID_V4 | true | The candidate ID for whom the operation will be performed. |
body | body | candidateTagDelete | false | none |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | successfullyCompletedRequest |
Add tags to the candidate.
Code samples
POST https://api.checkhub.io/candidateTags/{candidateId} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '[
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateTags/{candidateId}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
];
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateTags/{candidateId}',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/candidateTags/{candidateId}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/candidateTags/{candidateId}',
params: {
}, headers: headers
p JSON.parse(result)
POST /candidateTags/{candidateId}
Body parameter
[
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
candidateId | path | UUID_V4 | true | The candidate ID for whom the operation will be performed. |
body | body | candidateTagCreate | false | none |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z"
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateTagArray |
Candidate Selfie
Get candidate selfie collection
Code samples
GET https://api.checkhub.io/candidate-selfies HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-selfies',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-selfies',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/candidate-selfies', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/candidate-selfies',
params: {
}, headers: headers
p JSON.parse(result)
GET /candidate-selfies
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response. min: 1 , max: 100 , default: 10 |
skip | query | number | false | Number of items skipped during the selection. min: 0 , default: 0 |
order | query | string | false | Candidate Selfie collection order |
filter[candidateId] | query | UUID_V4 | false | Search by candidate selfie candidateId |
includeCandidate | query | boolean | false | To include candidate selfie 'candidate' relation |
includeFrontThumbnail | query | boolean | false | To include candidate selfie 'frontThumbnail' relation |
includeFront | query | boolean | false | To include candidate selfie 'front' relation |
includeLeft | query | boolean | false | To include candidate selfie 'left' relation |
includeRight | query | boolean | false | To include candidate selfie 'right' relation |
Enumerated Values
Parameter | Value |
---|---|
order | createdAt asc |
order | createdAt desc |
order | updatedAt asc |
order | updatedAt desc |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"frontThumbnailId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isLocked": false,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"frontId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"leftId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"rightId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"frontThumbnail": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
},
"front": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
},
"left": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
},
"right": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
}
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateSelfieFindResponse |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
200 | X-CURRENT-PAGE | integer | Current page | |
200 | X-PAGE-OFFSET | integer | Current offset | |
200 | X-PAGE-LIMIT | integer | Current limit | |
200 | X-TOTAL-PAGES | integer | The total number of pages. | |
200 | X-TOTAL-RECORDS | integer | The total number of items. |
Create new candidate selfie
Code samples
POST https://api.checkhub.io/candidate-selfies HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"frontId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"leftId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"rightId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-selfies',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"frontId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"leftId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"rightId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-selfies',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/candidate-selfies', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/candidate-selfies',
params: {
}, headers: headers
p JSON.parse(result)
POST /candidate-selfies
Body parameter
{
"frontId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"leftId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"rightId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
frontId | body | UUID_V4 | false | Unique identifier for the entity |
leftId | body | UUID_V4 | false | Unique identifier for the entity |
rightId | body | UUID_V4 | false | Unique identifier for the entity |
candidateId | body | UUID_V4 | true | Unique identifier for the entity |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"frontThumbnailId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isLocked": false,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"frontId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"leftId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"rightId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateSelfie |
Get candidate selfie by {{id}}
Code samples
GET https://api.checkhub.io/candidate-selfies/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-selfies/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-selfies/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/candidate-selfies/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/candidate-selfies/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /candidate-selfies/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
includeCandidate | query | boolean | false | To include candidate selfie 'candidate' relation |
includeFrontThumbnail | query | boolean | false | To include candidate selfie 'frontThumbnail' relation |
includeFront | query | boolean | false | To include candidate selfie 'front' relation |
includeLeft | query | boolean | false | To include candidate selfie 'left' relation |
includeRight | query | boolean | false | To include candidate selfie 'right' relation |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"frontThumbnailId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isLocked": false,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"frontId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"leftId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"rightId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"frontThumbnail": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
},
"front": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
},
"left": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
},
"right": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateSelfieFindByIdResponse |
Update candidate selfie by id
Code samples
PATCH https://api.checkhub.io/candidate-selfies/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"frontId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"leftId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"rightId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-selfies/{id}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"frontId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"leftId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"rightId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-selfies/{id}',
{
method: 'PATCH',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.patch('https://api.checkhub.io/candidate-selfies/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.patch 'https://api.checkhub.io/candidate-selfies/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /candidate-selfies/{id}
Body parameter
{
"frontId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"leftId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"rightId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be updated |
frontId | body | UUID_V4 | false | Unique identifier for the entity |
leftId | body | UUID_V4 | false | Unique identifier for the entity |
rightId | body | UUID_V4 | false | Unique identifier for the entity |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"frontThumbnailId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isLocked": false,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"frontId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"leftId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"rightId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateSelfie |
Delete candidate selfie by id
Code samples
DELETE https://api.checkhub.io/candidate-selfies/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-selfies/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-selfies/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.delete('https://api.checkhub.io/candidate-selfies/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.delete 'https://api.checkhub.io/candidate-selfies/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /candidate-selfies/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be deleted |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | successfullyCompletedRequest |
Download candidate selfie file (by candidate)
Code samples
GET https://api.checkhub.io/candidate-selfies/{id}/files/{fileId}/download HTTP/1.1
Host: api.checkhub.io
Accept: application/pdf
const headers = {
'Accept':'application/pdf',
'X-CSRF-TOKEN':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-selfies/{id}/files/{fileId}/download',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/pdf',
'X-CSRF-TOKEN':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-selfies/{id}/files/{fileId}/download',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/pdf',
'X-CSRF-TOKEN': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/candidate-selfies/{id}/files/{fileId}/download', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/pdf',
'X-CSRF-TOKEN' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/candidate-selfies/{id}/files/{fileId}/download',
params: {
}, headers: headers
p JSON.parse(result)
GET /candidate-selfies/{id}/files/{fileId}/download
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | UUID_V4 | true | The candidate selfie Id for download. |
fileId | path | UUID_V4 | true | The candidate selfie fileId for download. |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Candidate selfie file. | downloadFileResponse |
Candidate Custom Field
Add new custom fields for candidate
Code samples
POST https://api.checkhub.io/candidateCustomFields HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "1234-456-32"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateCustomFields',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "1234-456-32"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateCustomFields',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/candidateCustomFields', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/candidateCustomFields',
params: {
}, headers: headers
p JSON.parse(result)
POST /candidateCustomFields
Body parameter
{
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "1234-456-32"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
candidateId | body | UUID_V4 | true | Unique identifier for the entity |
customFieldId | body | UUID_V4 | true | Unique identifier for the entity |
value | body | any | false | none |
» anonymous | body | string | false | String custom field value |
» anonymous | body | string | false | Date custom field value (based on Company locale date format) |
» anonymous | body | string | false | Email custom field value |
» anonymous | body | string | false | Simple List selected option |
» anonymous | body | [string] | false | Multiple List selected options |
» anonymous | body | object | false | Simple Query selected option |
»» label | body | string | true | Option Label |
»» value | body | string | true | Option Value |
»» id | body | string | false | Option unique field |
» anonymous | body | [object] | false | Multiple Query selected options |
»» label | body | string | true | Option Label |
»» value | body | string | true | Option Value |
»» id | body | string | false | Option unique field |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "1234-456-32"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateCustomField |
Get list of candidate custom fields
Code samples
GET https://api.checkhub.io/candidateCustomFields HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateCustomFields',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateCustomFields',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/candidateCustomFields', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/candidateCustomFields',
params: {
}, headers: headers
p JSON.parse(result)
GET /candidateCustomFields
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response. min: 1 , max: 100 , default: 10 |
skip | query | number | false | Number of items skipped during the selection. min: 0 , default: 0 |
order | query | string | false | Candidate custom field collection order |
filter[candidateId] | query | UUID_V4 | false | Search by candidateId |
filter[customFieldId] | query | UUID_V4 | false | Search by customFieldId |
filter[value] | query | string | false | Search by value |
includeCustomField | query | boolean | false | To include candidate custom field 'customField' relation |
includeCandidate | query | boolean | false | To include candidate custom field 'candidate' relation |
Enumerated Values
Parameter | Value |
---|---|
order | candidateId asc |
order | candidateId desc |
order | value asc |
order | value desc |
order | customFieldId asc |
order | customFieldId desc |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "1234-456-32",
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"customField": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Document Number",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"reference": "DOC_NUM",
"fieldType": "string",
"description": "This custom field is required to store the passport series.",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"visibilityRules": {
"admin": {
"visible": true,
"editable": true,
"mandatory": false
},
"candidate": {
"visible": true,
"editable": true,
"mandatory": false
}
},
"accountIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"docTypeIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"orderNbr": 3
}
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateCustomFieldFindResponse |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
200 | X-CURRENT-PAGE | integer | Current page | |
200 | X-PAGE-OFFSET | integer | Current offset | |
200 | X-PAGE-LIMIT | integer | Current limit | |
200 | X-TOTAL-PAGES | integer | The total number of pages. | |
200 | X-TOTAL-RECORDS | integer | The total number of items. |
Deleting custom field by {{id}} from candidate
Code samples
DELETE https://api.checkhub.io/candidateCustomFields/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateCustomFields/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateCustomFields/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.delete('https://api.checkhub.io/candidateCustomFields/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.delete 'https://api.checkhub.io/candidateCustomFields/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /candidateCustomFields/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be deleted |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | successfullyCompletedRequest |
Get candidate custom field by {{id}}
Code samples
GET https://api.checkhub.io/candidateCustomFields/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateCustomFields/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateCustomFields/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/candidateCustomFields/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/candidateCustomFields/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /candidateCustomFields/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
includeCustomField | query | boolean | false | To include candidate custom field 'customField' relation |
includeCandidate | query | boolean | false | To include candidate custom field 'candidate' relation |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "1234-456-32",
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"customField": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Document Number",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"reference": "DOC_NUM",
"fieldType": "string",
"description": "This custom field is required to store the passport series.",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"visibilityRules": {
"admin": {
"visible": true,
"editable": true,
"mandatory": false
},
"candidate": {
"visible": true,
"editable": true,
"mandatory": false
}
},
"accountIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"docTypeIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"orderNbr": 3
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateCustomFieldFindByIdResponse |
Update candidate custom field by {{id}}
Code samples
PATCH https://api.checkhub.io/candidateCustomFields/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"value": "1234-456-32"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateCustomFields/{id}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"value": "1234-456-32"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateCustomFields/{id}',
{
method: 'PATCH',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.patch('https://api.checkhub.io/candidateCustomFields/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.patch 'https://api.checkhub.io/candidateCustomFields/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /candidateCustomFields/{id}
Body parameter
{
"value": "1234-456-32"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be updated |
value | body | string | true | The value of the candidate's custom field. |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "1234-456-32"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateCustomField |
Candidate Document Type
Create a new Candidate Document Type.
Code samples
POST https://api.checkhub.io/candidateDocumentTypes HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false,
"folder": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateDocumentTypes',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false,
"folder": "string"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateDocumentTypes',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/candidateDocumentTypes', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/candidateDocumentTypes',
params: {
}, headers: headers
p JSON.parse(result)
POST /candidateDocumentTypes
Body parameter
{
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false,
"folder": "string"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
documentTypeId | body | UUID_V4 | true | Unique identifier for the entity |
candidateId | body | UUID_V4 | true | Unique identifier for the entity |
name | body | string | false | Candidate Document Type name |
description | body | string | false | Candidate Document Type description |
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 | true | It says that Candidate Document Type is mandatory or optional for the candidate |
folder | body | string | false | Candidate Document Type files folder name |
Enumerated Values
Parameter | Value |
---|---|
commentType | info |
commentType | success |
commentType | warning |
commentType | danger |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"internal": false,
"folder": "string",
"customStatus": "pending",
"ocrParsedData": {},
"validationSnapshot": {
"total": 10,
"totalToBePending": 10,
"conditions": [
{
"type": "or",
"action": "score",
"score": 10,
"sequence": 1,
"isValid": true,
"validations": [
{
"rule": "string",
"method": "contains",
"value": {
"value": "value"
},
"fieldName": "firstName",
"fieldValue": "Field value",
"sequence": 1,
"isValid": true
}
]
}
]
},
"integrationTransferedAt": "string",
"mergeSetFilePath": "string",
"isMultiple": false,
"isProcessing": false,
"isPaused": false,
"combinedMultipleDocumentPath": "string",
"combinedMultipleDocumentName": "string",
"expiresOn": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateDocumentType |
Get candidate document type collection
Code samples
GET https://api.checkhub.io/candidateDocumentTypes HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateDocumentTypes',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateDocumentTypes',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/candidateDocumentTypes', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/candidateDocumentTypes',
params: {
}, headers: headers
p JSON.parse(result)
GET /candidateDocumentTypes
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response. min: 1 , max: 100 , default: 10 |
skip | query | number | false | Number of items skipped during the selection. min: 0 , default: 0 |
order | query | string | false | Candidate Document type collection order |
filter[accountId] | query | UUID_V4 | false | Filter result by candidate account id 'accountId' |
filter[accountIds][] | query | UUID_V4 | false | Filter result by candidate account ids 'accountIds' |
filter[candidateId] | query | UUID_V4 | false | Filter result by candidate id 'candidateId' |
filter[candidateEmail] | query | string | false | Filter result by candidate 'email' |
filter[candidateEmails][] | query | string | false | Filter result by candidate emails 'candidateEmails' |
filter[candidateArchived] | query | boolean | false | Filter result by candidate 'archived' |
filter[searchText] | query | string | false | Search result by following properties: ('candidate.email', 'candidate.firstName', 'candidate.lastName', 'name') |
filter[customStatuses][] | query | candidateDocumentTypeStatus | false | Filter result by custom statuses (or) |
filter[createdAtFrom] | query | DateISO | false | Filter result by creation time >= |
filter[createdAtTo] | query | DateISO | false | Filter result by creation time <= |
filter[updatedAtFrom] | query | DateISO | false | Filter result by update time >= |
filter[updatedAtTo] | query | DateISO | false | Filter result by update time <= |
filter[assigneeId] | query | UUID_V4 | false | Filter result by candidate 'assigneeId' field |
filter[assigneeIds][] | query | UUID_V4 | false | Filter result by candidate 'assigneeIds' field |
filter[isAssigned] | query | boolean | false | Filter result by 'isAssigned' candidate |
filter[internal] | query | boolean | false | Filter result by 'internal' flag |
includeCustomFields | query | boolean | false | To include 'customFields' relation |
includeDocumentType | query | boolean | false | To include 'documentType' relation |
includeCandidate | query | boolean | false | To include 'candidate' relation |
includeDocuments | query | boolean | false | To include 'documents' relation |
includeCandidateAssignee | query | boolean | false | To include candidate with 'assignee' relation |
includeCandidateSelfie | query | boolean | false | To include candidate with 'selfie' relation |
includeCandidateSelfieFront | query | boolean | false | To include candidate with 'selfie' relation with related 'front' relation |
includeCandidateSelfieFrontThumbnail | query | boolean | false | To include candidate with 'selfie' relation with related 'frontThumbnail' relation |
includeFaceMatch | query | boolean | false | To include 'faceMatch' relation |
includeImages | query | boolean | false | To include 'images' relation which is used for Face Matching |
Enumerated Values
Parameter | Value |
---|---|
order | id asc |
order | id desc |
order | name asc |
order | name desc |
order | createdAt asc |
order | createdAt desc |
order | updatedAt asc |
order | updatedAt desc |
filter[customStatuses][] | provided |
filter[customStatuses][] | pending |
filter[customStatuses][] | validated |
filter[customStatuses][] | expired |
filter[customStatuses][] | rejected |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"internal": false,
"folder": "string",
"customStatus": "pending",
"ocrParsedData": {},
"validationSnapshot": {
"total": 10,
"totalToBePending": 10,
"conditions": [
{
"type": "or",
"action": "score",
"score": 10,
"sequence": 1,
"isValid": true,
"validations": [
{
"rule": "string",
"method": "contains",
"value": {
"value": "value"
},
"fieldName": "firstName",
"fieldValue": "Field value",
"sequence": 1,
"isValid": true
}
]
}
]
},
"integrationTransferedAt": "string",
"mergeSetFilePath": "string",
"isMultiple": false,
"isProcessing": false,
"isPaused": false,
"combinedMultipleDocumentPath": "string",
"combinedMultipleDocumentName": "string",
"expiresOn": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false,
"documentType": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"name": "ASAP",
"reference": "dt_asap_eu",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"description": "Document Type description",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validationType": "auto",
"integrationSendOriginal": false,
"convertToPDF": false,
"isUnique": false,
"expiresInMonths": 2,
"isRectoVerso": false,
"advancedUploader": false,
"advancedUploaderSettings": {
"upload": false,
"scenario": "MrzAndLocate"
},
"skipBackup": false
},
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"documents": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"pdfFileName": "string",
"originFilePath": "string",
"originFileName": "string",
"thumbnailFilePath": "string",
"imageContentType": "image/jpeg",
"imageFileSize": 2952386,
"pdfFilePath": "string",
"isProcessing": false,
"position": 1
}
],
"customFields": [
{
"customField": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Document Number",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"reference": "DOC_NUM",
"fieldType": "string",
"description": "This custom field is required to store the passport series.",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"visibilityRules": {
"admin": {
"visible": true,
"editable": true,
"mandatory": false
},
"candidate": {
"visible": true,
"editable": true,
"mandatory": false
}
},
"accountIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"docTypeIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"orderNbr": 3
},
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "1234-456-32"
}
],
"faceMatch": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"similarity": 0.999332,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"images": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"type": "portrait",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateDocumentTypeFindResponse |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
200 | X-CURRENT-PAGE | integer | Current page | |
200 | X-PAGE-OFFSET | integer | Current offset | |
200 | X-PAGE-LIMIT | integer | Current limit | |
200 | X-TOTAL-PAGES | integer | The total number of pages. | |
200 | X-TOTAL-RECORDS | integer | The total number of items. |
Update candidate document types
Code samples
PATCH https://api.checkhub.io/candidateDocumentTypes HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customStatus": "validated",
"comment": "string",
"commentType": "info"
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateDocumentTypes',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customStatus": "validated",
"comment": "string",
"commentType": "info"
}
];
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidateDocumentTypes',
{
method: 'PATCH',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.patch('https://api.checkhub.io/candidateDocumentTypes', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.patch 'https://api.checkhub.io/candidateDocumentTypes',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /candidateDocumentTypes
Body parameter
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customStatus": "validated",
"comment": "string",
"commentType": "info"
}
]
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
body | body | candidateDocumentTypeUpdateBody | false | none |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"internal": false,
"folder": "string",
"customStatus": "pending",
"ocrParsedData": {},
"validationSnapshot": {
"total": 10,
"totalToBePending": 10,
"conditions": [
{
"type": "or",
"action": "score",
"score": 10,
"sequence": 1,
"isValid": true,
"validations": [
{
"rule": "string",
"method": "contains",
"value": {
"value": "value"
},
"fieldName": "firstName",
"fieldValue": "Field value",
"sequence": 1,
"isValid": true
}
]
}
]
},
"integrationTransferedAt": "string",
"mergeSetFilePath": "string",
"isMultiple": false,
"isProcessing": false,
"isPaused": false,
"combinedMultipleDocumentPath": "string",
"combinedMultipleDocumentName": "string",
"expiresOn": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateDocumentTypeArray |
Change candidate document types
Code samples
PUT https://api.checkhub.io/candidateDocumentTypes HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"create": [
{
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false,
"folder": "string"
}
],
"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": [
{
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false,
"folder": "string"
}
],
"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": [
{
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false,
"folder": "string"
}
],
"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": "pending",
"ocrParsedData": {},
"validationSnapshot": {
"total": 10,
"totalToBePending": 10,
"conditions": [
{
"type": "or",
"action": "score",
"score": 10,
"sequence": 1,
"isValid": true,
"validations": [
{
"rule": "string",
"method": "contains",
"value": {
"value": "value"
},
"fieldName": "firstName",
"fieldValue": "Field value",
"sequence": 1,
"isValid": true
}
]
}
]
},
"integrationTransferedAt": "string",
"mergeSetFilePath": "string",
"isMultiple": false,
"isProcessing": false,
"isPaused": false,
"combinedMultipleDocumentPath": "string",
"combinedMultipleDocumentName": "string",
"expiresOn": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false
}
]
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | 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. min: 1 , max: 100 , default: 10 |
skip | query | number | false | Number of items skipped during the selection. min: 0 , default: 0 |
order | query | string | false | Candidate Document type collection order |
filter[accountId] | query | UUID_V4 | false | Filter result by candidate account id 'accountId' |
filter[accountIds][] | query | UUID_V4 | false | Filter result by candidate account ids 'accountIds' |
filter[candidateId] | query | UUID_V4 | false | Filter result by candidate id 'candidateId' |
filter[candidateEmail] | query | string | false | Filter result by candidate 'email' |
filter[candidateEmails][] | query | string | false | Filter result by candidate emails 'candidateEmails' |
filter[candidateArchived] | query | boolean | false | Filter result by candidate 'archived' |
filter[searchText] | query | string | false | Search result by following properties: ('candidate.email', 'candidate.firstName', 'candidate.lastName', 'name') |
filter[customStatuses][] | query | candidateDocumentTypeStatus | false | Filter result by custom statuses (or) |
filter[assigneeId] | query | UUID_V4 | false | Filter result by candidate 'assigneeId' field |
filter[assigneeIds][] | query | UUID_V4 | false | Filter result by candidate 'assigneeIds' field |
filter[isAssigned] | query | boolean | false | Filter result by 'isAssigned' candidate |
filter[internal] | query | boolean | false | Filter result by 'internal' flag |
ids | body | [UUID_V4] | true | Candidate document type ids |
Enumerated Values
Parameter | Value |
---|---|
order | id asc |
order | id desc |
order | name asc |
order | name desc |
order | createdAt asc |
order | createdAt desc |
order | updatedAt asc |
order | updatedAt desc |
filter[customStatuses][] | provided |
filter[customStatuses][] | pending |
filter[customStatuses][] | validated |
filter[customStatuses][] | expired |
filter[customStatuses][] | rejected |
Example responses
200 Response
{
"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 should 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 |
includeCandidateAssignee | query | boolean | false | To include candidate with 'assignee' relation |
includeCandidateSelfie | query | boolean | false | To include candidate with 'selfie' relation |
includeCandidateSelfieFront | query | boolean | false | To include candidate with 'selfie' relation with related 'front' relation |
includeCandidateSelfieFrontThumbnail | query | boolean | false | To include candidate with 'selfie' relation with related 'frontThumbnail' relation |
includeFaceMatch | query | boolean | false | To include 'faceMatch' relation |
includeImages | query | boolean | false | To include 'images' relation which is used for Face Matching |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"internal": false,
"folder": "string",
"customStatus": "pending",
"ocrParsedData": {},
"validationSnapshot": {
"total": 10,
"totalToBePending": 10,
"conditions": [
{
"type": "or",
"action": "score",
"score": 10,
"sequence": 1,
"isValid": true,
"validations": [
{
"rule": "string",
"method": "contains",
"value": {
"value": "value"
},
"fieldName": "firstName",
"fieldValue": "Field value",
"sequence": 1,
"isValid": true
}
]
}
]
},
"integrationTransferedAt": "string",
"mergeSetFilePath": "string",
"isMultiple": false,
"isProcessing": false,
"isPaused": false,
"combinedMultipleDocumentPath": "string",
"combinedMultipleDocumentName": "string",
"expiresOn": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false,
"documentType": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"name": "ASAP",
"reference": "dt_asap_eu",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"description": "Document Type description",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validationType": "auto",
"integrationSendOriginal": false,
"convertToPDF": false,
"isUnique": false,
"expiresInMonths": 2,
"isRectoVerso": false,
"advancedUploader": false,
"advancedUploaderSettings": {
"upload": false,
"scenario": "MrzAndLocate"
},
"skipBackup": false
},
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"documents": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"pdfFileName": "string",
"originFilePath": "string",
"originFileName": "string",
"thumbnailFilePath": "string",
"imageContentType": "image/jpeg",
"imageFileSize": 2952386,
"pdfFilePath": "string",
"isProcessing": false,
"position": 1
}
],
"customFields": [
{
"customField": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Document Number",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"reference": "DOC_NUM",
"fieldType": "string",
"description": "This custom field is required to store the passport series.",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"visibilityRules": {
"admin": {
"visible": true,
"editable": true,
"mandatory": false
},
"candidate": {
"visible": true,
"editable": true,
"mandatory": false
}
},
"accountIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"docTypeIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"orderNbr": 3
},
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "1234-456-32"
}
],
"faceMatch": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"similarity": 0.999332,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"images": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"type": "portrait",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | 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 should 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": "pending",
"ocrParsedData": {},
"validationSnapshot": {
"total": 10,
"totalToBePending": 10,
"conditions": [
{
"type": "or",
"action": "score",
"score": 10,
"sequence": 1,
"isValid": true,
"validations": [
{
"rule": "string",
"method": "contains",
"value": {
"value": "value"
},
"fieldName": "firstName",
"fieldValue": "Field value",
"sequence": 1,
"isValid": true
}
]
}
]
},
"integrationTransferedAt": "string",
"mergeSetFilePath": "string",
"isMultiple": false,
"isProcessing": false,
"isPaused": false,
"combinedMultipleDocumentPath": "string",
"combinedMultipleDocumentName": "string",
"expiresOn": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateDocumentType |
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}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be deleted |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | successfullyCompletedRequest |
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. min: 1 , max: 100 , default: 10 |
skip | query | number | false | Number of items skipped during the selection. min: 0 , default: 0 |
order | query | string | false | Candidate Document type collection order |
filter[accountId] | query | UUID_V4 | false | Filter result by candidate account id 'accountId' |
filter[accountIds][] | query | UUID_V4 | false | Filter result by candidate account ids 'accountIds' |
filter[candidateId] | query | UUID_V4 | false | Filter result by candidate id 'candidateId' |
filter[candidateEmail] | query | string | false | Filter result by candidate 'email' |
filter[candidateEmails][] | query | string | false | Filter result by candidate emails 'candidateEmails' |
filter[candidateArchived] | query | boolean | false | Filter result by candidate 'archived' |
filter[searchText] | query | string | false | Search result by following properties: ('candidate.email', 'candidate.firstName', 'candidate.lastName', 'name') |
filter[customStatuses][] | query | candidateDocumentTypeStatus | false | Filter result by custom statuses (or) |
filter[assigneeId] | query | UUID_V4 | false | Filter result by candidate 'assigneeId' field |
filter[assigneeIds][] | query | UUID_V4 | false | Filter result by candidate 'assigneeIds' field |
filter[isAssigned] | query | boolean | false | Filter result by 'isAssigned' candidate |
filter[internal] | query | boolean | false | Filter result by 'internal' flag |
ids | body | [UUID_V4] | false | Array of candidate document type ids |
Enumerated Values
Parameter | Value |
---|---|
order | id asc |
order | id desc |
order | name asc |
order | name desc |
order | createdAt asc |
order | createdAt desc |
order | updatedAt asc |
order | updatedAt desc |
filter[customStatuses][] | provided |
filter[customStatuses][] | pending |
filter[customStatuses][] | validated |
filter[customStatuses][] | expired |
filter[customStatuses][] | rejected |
Example responses
200 Response
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. min: 1 , max: 100 , default: 10 |
skip | query | number | false | Number of items skipped during the selection. min: 0 , default: 0 |
order | query | string | false | Candidate Document type collection order |
filter[accountId] | query | UUID_V4 | false | Filter result by candidate account id 'accountId' |
filter[accountIds][] | query | UUID_V4 | false | Filter result by candidate account ids 'accountIds' |
filter[candidateId] | query | UUID_V4 | false | Filter result by candidate id 'candidateId' |
filter[candidateEmail] | query | string | false | Filter result by candidate 'email' |
filter[candidateEmails][] | query | string | false | Filter result by candidate emails 'candidateEmails' |
filter[candidateArchived] | query | boolean | false | Filter result by candidate 'archived' |
filter[searchText] | query | string | false | Search result by following properties: ('candidate.email', 'candidate.firstName', 'candidate.lastName', 'name') |
filter[customStatuses][] | query | candidateDocumentTypeStatus | false | Filter result by custom statuses (or) |
filter[assigneeId] | query | UUID_V4 | false | Filter result by candidate 'assigneeId' field |
filter[assigneeIds][] | query | UUID_V4 | false | Filter result by candidate 'assigneeIds' field |
filter[isAssigned] | query | boolean | false | Filter result by 'isAssigned' candidate |
filter[internal] | query | boolean | false | Filter result by 'internal' flag |
Enumerated Values
Parameter | Value |
---|---|
order | id asc |
order | id desc |
order | name asc |
order | name desc |
order | createdAt asc |
order | createdAt desc |
order | updatedAt asc |
order | updatedAt desc |
filter[customStatuses][] | provided |
filter[customStatuses][] | pending |
filter[customStatuses][] | validated |
filter[customStatuses][] | expired |
filter[customStatuses][] | rejected |
Example responses
200 Response
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 should 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 should 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",
"candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"pdfFileName": "string",
"originFilePath": "string",
"originFileName": "string",
"thumbnailFilePath": "string",
"imageContentType": "image/jpeg",
"imageFileSize": 2952386,
"pdfFilePath": "string",
"isProcessing": false,
"position": 1
}
]
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 should 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}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
candidateDocumentTypeId | path | string | true | Candidate document type id which should 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"
}
}
],
"status": "requested",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies"
}
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": {
"checkbox": false,
"text": "Mask",
"email": "Mask",
"signature": "data:image/png;base64,iVBORw0KGg"
}
}
],
"status": "requested",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies"
}
]
}
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. min: 1 , max: 100 , default: 10 |
skip | query | number | false | Number of items skipped during the selection. min: 0 , default: 0 |
order | query | string | false | Candidate 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"
}
}
],
"status": "requested",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies",
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"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. |
Deleting 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 |
Deleting 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 should 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 should 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"
}
}
],
"status": "requested",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies",
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"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 should 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"
}
}
],
"status": "requested",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies"
}
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 should be updated |
action | path | string | true | 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"
}
}
],
"status": "requested",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies",
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"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 should 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 Form
Create Candidate Form
Code samples
POST https://api.checkhub.io/candidate-forms HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"isPreliminary": false,
"folder": "Registration",
"metadata": {},
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-forms',
{
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",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"isPreliminary": false,
"folder": "Registration",
"metadata": {},
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-forms',
{
method: 'POST',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/candidate-forms', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/candidate-forms',
params: {
}, headers: headers
p JSON.parse(result)
POST /candidate-forms
Body parameter
{
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"isPreliminary": false,
"folder": "Registration",
"metadata": {},
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
candidateId | body | UUID_V4 | true | Unique identifier for the entity |
formId | body | UUID_V4 | true | Unique identifier for the entity |
actions | body | [formAction] | true | Form actions (at least one action required); Please note that allowable actions depend on the type of the original form:
|
isMandatory | body | boolean | false | Is candidate form mandatory |
isPreliminary | body | boolean | false | Is candidate form preliminary |
folder | body | string | false | Folder name |
metadata | body | object | false | Candidate Form metadata (external properties) |
fileId | body | UUID_V4 | false | Unique identifier for the entity |
signatureId | body | UUID_V4 | false | Unique identifier for the entity |
Enumerated Values
Parameter | Value |
---|---|
actions | read |
actions | complete |
actions | eSign |
actions | download |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Initial",
"folder": "Registration",
"actions": [
"complete",
"download"
],
"completedActions": [
"complete",
"download"
],
"isLocked": false,
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"isPdfGenerationEnabled": false,
"pdfFilePath": "pdf/file/path",
"pdfFileName": "string",
"remotePdfFilePath": "string",
"status": "requested",
"type": "editable",
"isAddition": false,
"parentId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"metadata": {},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateForm |
Get Candidate Form Collection
Code samples
GET https://api.checkhub.io/candidate-forms HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-forms',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-forms',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/candidate-forms', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/candidate-forms',
params: {
}, headers: headers
p JSON.parse(result)
GET /candidate-forms
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response. min: 1 , max: 100 , default: 10 |
skip | query | number | false | Number of items skipped during the selection. min: 0 , default: 0 |
order | query | string | false | Candidate Form collection order |
filter[ids][] | query | UUID_V4 | false | Search by candidate form ids |
filter[name] | query | string | false | Search by candidate form name |
filter[candidateId] | query | UUID_V4 | false | Search by candidateId |
filter[formId] | query | UUID_V4 | false | Search by formId |
filter[createdAtFrom] | query | DateISO | false | Filter result by creation time >= |
filter[createdAtTo] | query | DateISO | false | Filter result by creation time <= |
filter[updatedAtFrom] | query | DateISO | false | Filter result by update time >= |
filter[updatedAtTo] | query | DateISO | false | Filter result by update time <= |
filter[assigneeId] | query | UUID_V4 | false | Filter result by candidate 'assigneeId' field |
filter[isAssigned] | query | boolean | false | Filter result by 'isAssigned' candidate |
includeForm | query | boolean | false | You can include 'form' relation |
includeCandidate | query | boolean | false | You can include 'candidate' relation |
includeAdditions | query | boolean | false | You can include addition candidate forms 'additions' relation |
includeAdditionsData | query | boolean | false | You can include addition candidate forms 'additions' with addition candidate form data relation |
includeCandidateAssignee | query | boolean | false | You can include candidate 'assignee' 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",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Initial",
"folder": "Registration",
"actions": [
"complete",
"download"
],
"completedActions": [
"complete",
"download"
],
"isLocked": false,
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"isPdfGenerationEnabled": false,
"pdfFilePath": "pdf/file/path",
"pdfFileName": "string",
"remotePdfFilePath": "string",
"status": "requested",
"type": "editable",
"isAddition": false,
"parentId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"metadata": {},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"form": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Work Permit",
"reference": "work_permit",
"shareCode": "",
"type": "editable",
"language": "en",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"updatedById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"additions": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Initial",
"folder": "Registration",
"actions": [
"complete",
"download"
],
"completedActions": [
"complete",
"download"
],
"isLocked": false,
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"isPdfGenerationEnabled": false,
"pdfFilePath": "pdf/file/path",
"pdfFileName": "string",
"remotePdfFilePath": "string",
"status": "requested",
"type": "editable",
"isAddition": false,
"parentId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"metadata": {},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateFormFindResponse |
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 Candidate Form by {{id}}
Code samples
GET https://api.checkhub.io/candidate-forms/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-forms/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-forms/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/candidate-forms/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/candidate-forms/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /candidate-forms/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
includeForm | query | boolean | false | You can include 'form' relation |
includeCandidate | query | boolean | false | You can include 'candidate' relation |
includeData | query | boolean | false | You can include 'data' relation |
includeAdditions | query | boolean | false | You can include addition candidate forms 'additions' relation |
includeAdditionsData | query | boolean | false | You can include addition candidate forms 'additions' with addition candidate form data relation |
includeCandidateAssignee | query | boolean | false | You can include candidate 'assignee' relation |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Initial",
"folder": "Registration",
"actions": [
"complete",
"download"
],
"completedActions": [
"complete",
"download"
],
"isLocked": false,
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"isPdfGenerationEnabled": false,
"pdfFilePath": "pdf/file/path",
"pdfFileName": "string",
"remotePdfFilePath": "string",
"status": "requested",
"type": "editable",
"isAddition": false,
"parentId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"metadata": {},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"form": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Work Permit",
"reference": "work_permit",
"shareCode": "",
"type": "editable",
"language": "en",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"updatedById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"data": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateFormId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fields": {},
"context": {},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"additions": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Initial",
"folder": "Registration",
"actions": [
"complete",
"download"
],
"completedActions": [
"complete",
"download"
],
"isLocked": false,
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"isPdfGenerationEnabled": false,
"pdfFilePath": "pdf/file/path",
"pdfFileName": "string",
"remotePdfFilePath": "string",
"status": "requested",
"type": "editable",
"isAddition": false,
"parentId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"metadata": {},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateFormFindByIdResponse |
Update Candidate Form by {{id}}
Code samples
PATCH https://api.checkhub.io/candidate-forms/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"actions": [
"complete",
"download"
],
"isMandatory": false,
"isPreliminary": false,
"folder": "Registration",
"metadata": {}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-forms/{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"
],
"isMandatory": false,
"isPreliminary": false,
"folder": "Registration",
"metadata": {}
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-forms/{id}',
{
method: 'PATCH',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.patch('https://api.checkhub.io/candidate-forms/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.patch 'https://api.checkhub.io/candidate-forms/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /candidate-forms/{id}
Body parameter
{
"actions": [
"complete",
"download"
],
"isMandatory": false,
"isPreliminary": false,
"folder": "Registration",
"metadata": {}
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be updated |
actions | body | [formAction] | false | Form actions (at least one action required); Please note that allowable actions depend on the type of the original form:
|
isMandatory | body | boolean | false | Is candidate form mandatory |
isPreliminary | body | boolean | false | Is candidate form preliminary |
folder | body | string | false | Folder name |
metadata | body | object | false | Candidate Form metadata (external properties) |
Enumerated Values
Parameter | Value |
---|---|
actions | read |
actions | complete |
actions | eSign |
actions | download |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Initial",
"folder": "Registration",
"actions": [
"complete",
"download"
],
"completedActions": [
"complete",
"download"
],
"isLocked": false,
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"isPdfGenerationEnabled": false,
"pdfFilePath": "pdf/file/path",
"pdfFileName": "string",
"remotePdfFilePath": "string",
"status": "requested",
"type": "editable",
"isAddition": false,
"parentId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"metadata": {},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateForm |
Delete Candidate Form by {{id}}
Code samples
DELETE https://api.checkhub.io/candidate-forms/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-forms/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-forms/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.delete('https://api.checkhub.io/candidate-forms/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.delete 'https://api.checkhub.io/candidate-forms/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /candidate-forms/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be deleted |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateFormSuccessResponse |
Set completed action by candidate
Code samples
PUT https://api.checkhub.io/candidate-forms/{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"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-CSRF-TOKEN':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-forms/{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"
}
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'X-CSRF-TOKEN':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-forms/{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/candidate-forms/{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/candidate-forms/{id}/{action}',
params: {
}, headers: headers
p JSON.parse(result)
PUT /candidate-forms/{id}/{action}
Body parameter
{
"fields": {
"{field reference for checkbox}": false,
"{field reference for text}": "Mask"
}
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be updated |
action | path | string | true | Action 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. |
Enumerated Values
Parameter | Value |
---|---|
action | read |
action | complete |
action | eSign |
action | download |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Initial",
"folder": "Registration",
"actions": [
"complete",
"download"
],
"completedActions": [
"complete",
"download"
],
"isLocked": false,
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"isPdfGenerationEnabled": false,
"pdfFilePath": "pdf/file/path",
"pdfFileName": "string",
"remotePdfFilePath": "string",
"status": "requested",
"type": "editable",
"isAddition": false,
"parentId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"metadata": {},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateForm |
Candidate Form Data
Get candidate form data by {{id}}
Code samples
GET https://api.checkhub.io/candidate-form-data/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-form-data/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidate-form-data/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/candidate-form-data/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/candidate-form-data/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /candidate-form-data/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateFormId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fields": {},
"context": {},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | candidateFormData |
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. min: 1 , max: 100 , default: 10 |
skip | query | number | false | Number of items skipped during the selection. min: 0 , default: 0 |
order | query | string | false | Candidate 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"
]
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": true,
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
],
"company": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it",
"pl",
"ro",
"sq",
"be",
"bg",
"hr",
"cs",
"da",
"et",
"fi",
"el",
"hu",
"is",
"ga",
"lv",
"lt",
"mk",
"mt",
"no",
"pt",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"uk",
"cy"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
}
}
]
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"
]
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": true,
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
}';
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"
]
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": true,
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
};
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"
]
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": true,
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
}
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) |
forms | body | [candidatePresetForm] | false | Forms to be applied to the candidate. |
» id | body | UUID_V4 | true | Unique identifier for the entity |
» actions | body | [formAction] | true | Form actions (at least one action required); Please note that allowable actions depend on the type of the original form:
|
» isMandatory | body | boolean | true | It says that form is mandatory or optional for the candidate. |
» signatureId | body | UUID_V4 | false | Unique identifier for the entity |
Enumerated Values
Parameter | Value |
---|---|
» commentType | info |
» commentType | success |
» commentType | warning |
» commentType | danger |
» actions | read |
» actions | complete |
» actions | download |
» actions | read |
» actions | complete |
» actions | eSign |
» 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"
]
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": true,
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
}
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 should 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"
]
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": true,
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
],
"company": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it",
"pl",
"ro",
"sq",
"be",
"bg",
"hr",
"cs",
"da",
"et",
"fi",
"el",
"hu",
"is",
"ga",
"lv",
"lt",
"mk",
"mt",
"no",
"pt",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"uk",
"cy"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
}
}
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"
]
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": true,
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
}';
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"
]
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": true,
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
};
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"
]
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": true,
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should 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) |
forms | body | [candidatePresetForm] | false | Forms to be applied to the candidate. |
» id | body | UUID_V4 | true | Unique identifier for the entity |
» actions | body | [formAction] | true | Form actions (at least one action required); Please note that allowable actions depend on the type of the original form:
|
» isMandatory | body | boolean | true | It says that form is mandatory or optional for the candidate. |
» signatureId | body | UUID_V4 | false | Unique identifier for the entity |
Enumerated Values
Parameter | Value |
---|---|
» commentType | info |
» commentType | success |
» commentType | warning |
» commentType | danger |
» actions | read |
» actions | complete |
» actions | download |
» actions | read |
» actions | complete |
» actions | eSign |
» 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"
]
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": true,
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
}
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
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/candidatePresets/{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/candidatePresets/{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/candidatePresets/{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/candidatePresets/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /candidatePresets/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be deleted |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | successfullyCompletedRequest |
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",
"it",
"pl",
"ro",
"sq",
"be",
"bg",
"hr",
"cs",
"da",
"et",
"fi",
"el",
"hu",
"is",
"ga",
"lv",
"lt",
"mk",
"mt",
"no",
"pt",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"uk",
"cy"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
},
"policy": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | companyFindByMeResponse |
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 |
Company Signature Role
Get company signature role collection
Code samples
GET https://api.checkhub.io/company-signature-roles HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/company-signature-roles',
{
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/company-signature-roles',
{
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/company-signature-roles', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/company-signature-roles',
params: {
}, headers: headers
p JSON.parse(result)
GET /company-signature-roles
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response. min: 1 , max: 100 , default: 10 |
skip | query | number | false | Number of items skipped during the selection. min: 0 , default: 0 |
order | query | string | false | Company signature role collection order |
includeEntity | query | boolean | false | To include company signature role entity. It could be 'candidate' or 'adminUser' 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",
"isDefault": false,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Company Signature role",
"entity": "adminUser",
"entityId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"adminUser": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"lastActivityAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"isOwner": false
}
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | companySignatureRoleFindResponse |
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 company signature role
Code samples
POST https://api.checkhub.io/company-signature-roles HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"name": "Company Signature role",
"entity": "adminUser",
"entityId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/company-signature-roles',
{
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": "Company Signature role",
"entity": "adminUser",
"entityId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/company-signature-roles',
{
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/company-signature-roles', 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/company-signature-roles',
params: {
}, headers: headers
p JSON.parse(result)
POST /company-signature-roles
Body parameter
{
"name": "Company Signature role",
"entity": "adminUser",
"entityId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
name | body | string | true | Company signature role name |
entity | body | companySignatureRoleEntity | true | none |
entityId | body | UUID_V4 | true | Unique identifier for the entity |
Enumerated Values
Parameter | Value |
---|---|
entity | adminUser |
entity | candidate |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isDefault": false,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Company Signature role",
"entity": "adminUser",
"entityId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | companySignatureRole |
Get company signature role by {{id}}
Code samples
GET https://api.checkhub.io/company-signature-roles/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/company-signature-roles/{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/company-signature-roles/{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/company-signature-roles/{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/company-signature-roles/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /company-signature-roles/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isDefault": false,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Company Signature role",
"entity": "adminUser",
"entityId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"adminUser": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"lastActivityAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"isOwner": false
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | companySignatureRoleFindByIdResponse |
Update company signature role by {{id}}
Code samples
PATCH https://api.checkhub.io/company-signature-roles/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"name": "Company Signature role",
"entity": "adminUser",
"entityId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/company-signature-roles/{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": "Company Signature role",
"entity": "adminUser",
"entityId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/company-signature-roles/{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/company-signature-roles/{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/company-signature-roles/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /company-signature-roles/{id}
Body parameter
{
"name": "Company Signature role",
"entity": "adminUser",
"entityId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be updated |
name | body | string | false | Company signature role name |
entity | body | companySignatureRoleEntity | false | none |
entityId | body | UUID_V4 | false | Unique identifier for the entity |
Enumerated Values
Parameter | Value |
---|---|
entity | adminUser |
entity | candidate |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isDefault": false,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Company Signature role",
"entity": "adminUser",
"entityId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | companySignatureRole |
Delete company signature role by {{id}}
Code samples
DELETE https://api.checkhub.io/company-signature-roles/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/company-signature-roles/{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/company-signature-roles/{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/company-signature-roles/{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/company-signature-roles/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /company-signature-roles/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be deleted |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | successfullyCompletedRequest |
Custom Field
Add new custom field
Code samples
POST https://api.checkhub.io/customFields HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"name": "Document Number",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"reference": "DOC_NUM",
"model": "candidate",
"fieldType": "string",
"description": "This custom field is required to store the passport series.",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"visibilityRules": {
"admin": {
"visible": true,
"editable": true,
"mandatory": false
},
"candidate": {
"visible": true,
"editable": true,
"mandatory": false
}
},
"accountIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"docTypeIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"orderNbr": 3
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/customFields',
{
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": "Document Number",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"reference": "DOC_NUM",
"model": "candidate",
"fieldType": "string",
"description": "This custom field is required to store the passport series.",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"visibilityRules": {
"admin": {
"visible": true,
"editable": true,
"mandatory": false
},
"candidate": {
"visible": true,
"editable": true,
"mandatory": false
}
},
"accountIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"docTypeIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"orderNbr": 3
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/customFields',
{
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/customFields', 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/customFields',
params: {
}, headers: headers
p JSON.parse(result)
POST /customFields
Body parameter
{
"name": "Document Number",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"reference": "DOC_NUM",
"model": "candidate",
"fieldType": "string",
"description": "This custom field is required to store the passport series.",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"visibilityRules": {
"admin": {
"visible": true,
"editable": true,
"mandatory": false
},
"candidate": {
"visible": true,
"editable": true,
"mandatory": false
}
},
"accountIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"docTypeIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"orderNbr": 3
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
body | body | customFieldCreate | false | none |
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": "Document Number",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"reference": "DOC_NUM",
"fieldType": "string",
"description": "This custom field is required to store the passport series.",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"visibilityRules": {
"admin": {
"visible": true,
"editable": true,
"mandatory": false
},
"candidate": {
"visible": true,
"editable": true,
"mandatory": false
}
},
"accountIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"docTypeIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"orderNbr": 3
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | customField |
Get list of custom fields
Code samples
GET https://api.checkhub.io/customFields HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/customFields',
{
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/customFields',
{
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/customFields', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/customFields',
params: {
}, headers: headers
p JSON.parse(result)
GET /customFields
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response. min: 1 , max: 100 , default: 10 |
skip | query | number | false | Number of items skipped during the selection. min: 0 , default: 0 |
order | query | string | false | Custom field collection order |
filter[reference] | query | string | false | Search by custom field reference |
filter[model] | query | string | false | Search by custom field model |
filter[name] | query | string | false | Search by custom field name |
Enumerated Values
Parameter | Value |
---|---|
order | name asc |
order | name desc |
order | createdAt asc |
order | createdAt desc |
order | orderNbr asc |
order | orderNbr desc |
filter[model] | candidate |
filter[model] | document |
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": "Document Number",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"reference": "DOC_NUM",
"fieldType": "string",
"description": "This custom field is required to store the passport series.",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"visibilityRules": {
"admin": {
"visible": true,
"editable": true,
"mandatory": false
},
"candidate": {
"visible": true,
"editable": true,
"mandatory": false
}
},
"accountIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"docTypeIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"orderNbr": 3
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | customFieldArray |
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}}
Code samples
DELETE https://api.checkhub.io/customFields/{id} HTTP/1.1
Host: api.checkhub.io
const headers = {
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/customFields/{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/customFields/{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/customFields/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'API_KEY'
}
result = RestClient.delete 'https://api.checkhub.io/customFields/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /customFields/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be deleted |
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Request was successful | None |
Get custom field by {{id}}
Code samples
GET https://api.checkhub.io/customFields/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/customFields/{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/customFields/{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/customFields/{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/customFields/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /customFields/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Document Number",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"reference": "DOC_NUM",
"fieldType": "string",
"description": "This custom field is required to store the passport series.",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"visibilityRules": {
"admin": {
"visible": true,
"editable": true,
"mandatory": false
},
"candidate": {
"visible": true,
"editable": true,
"mandatory": false
}
},
"accountIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"docTypeIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"orderNbr": 3
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | customField |
Update custom field by {{id}}
Code samples
PATCH https://api.checkhub.io/customFields/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"name": "Document Number",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"reference": "DOC_NUM",
"fieldType": "string",
"description": "This custom field is required to store the passport series.",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"visibilityRules": {
"admin": {
"visible": true,
"editable": true,
"mandatory": false
},
"candidate": {
"visible": true,
"editable": true,
"mandatory": false
}
},
"accountIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"docTypeIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"orderNbr": 3
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/customFields/{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": "Document Number",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"reference": "DOC_NUM",
"fieldType": "string",
"description": "This custom field is required to store the passport series.",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"visibilityRules": {
"admin": {
"visible": true,
"editable": true,
"mandatory": false
},
"candidate": {
"visible": true,
"editable": true,
"mandatory": false
}
},
"accountIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"docTypeIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"orderNbr": 3
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/customFields/{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/customFields/{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/customFields/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /customFields/{id}
Body parameter
{
"name": "Document Number",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"reference": "DOC_NUM",
"fieldType": "string",
"description": "This custom field is required to store the passport series.",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"visibilityRules": {
"admin": {
"visible": true,
"editable": true,
"mandatory": false
},
"candidate": {
"visible": true,
"editable": true,
"mandatory": false
}
},
"accountIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"docTypeIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"orderNbr": 3
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be updated |
body | body | customFieldUpdate | false | none |
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": "Document Number",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"reference": "DOC_NUM",
"fieldType": "string",
"description": "This custom field is required to store the passport series.",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"visibilityRules": {
"admin": {
"visible": true,
"editable": true,
"mandatory": false
},
"candidate": {
"visible": true,
"editable": true,
"mandatory": false
}
},
"accountIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"docTypeIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"orderNbr": 3
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | customField |
Container
Upload file for the candidate document
Code samples
POST https://api.checkhub.io/containers/{candidateDocumentTypeId}/upload HTTP/1.1
Host: api.checkhub.io
Content-Type: multipart/form-data
Accept: application/json
const inputBody = '{
"{documentTypeId}": "There should be your file in binary format"
}';
const headers = {
'Content-Type':'multipart/form-data',
'Accept':'application/json',
'X-CSRF-TOKEN':'API_KEY'
};
fetch('https://api.checkhub.io/containers/{candidateDocumentTypeId}/upload',
{
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}": "There should be your file in binary format"
};
const headers = {
'Content-Type':'multipart/form-data',
'Accept':'application/json',
'X-CSRF-TOKEN':'API_KEY'
};
fetch('https://api.checkhub.io/containers/{candidateDocumentTypeId}/upload',
{
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',
'X-CSRF-TOKEN': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/containers/{candidateDocumentTypeId}/upload', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
'X-CSRF-TOKEN' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/containers/{candidateDocumentTypeId}/upload',
params: {
}, headers: headers
p JSON.parse(result)
POST /containers/{candidateDocumentTypeId}/upload
This method is intended for uploading files using the candidate's token. The "position" property works only for files that are uploaded in "isMultiple" mode and determines their order when creating a .pdf file from images. For documents that have "isRectoVerso = true", position must strictly define the side of the document: 0 - recto, 1 - verso.
Body parameter
"{documentTypeId}": There should be your file in binary format
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
candidateDocumentTypeId | path | string | true | ID of the document type of the candidate to which file should be uploaded |
isMultiple | query | boolean | false | Does this document contain multiple files |
position | query | number | false | The order of the uploaded file. If the file already exists at this position, it will be replaced. |
body | body | containerUpload | false | none |
Example responses
200 Response
{
"result": {
"fields": {},
"files": {
"{documentTypeId}": [
{
"candidateDocumentId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"container": "7e4236be-b328-4905-8f91-e46b5b47f0b7",
"field": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "document.pdf",
"size": 394867,
"type": "application/pdf"
}
]
}
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | containerUploadResponse |
DAAS Request
Create new DAAS Request.
Code samples
POST https://api.checkhub.io/requests HTTP/1.1
Host: api.checkhub.io
Content-Type: multipart/form-data
Accept: application/json
const inputBody = '{
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"files": [
"There should be your file in binary format"
],
"metadata": {}
}';
const headers = {
'Content-Type':'multipart/form-data',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/requests',
{
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",
"files": [
"There should be your file in binary format"
],
"metadata": {}
};
const headers = {
'Content-Type':'multipart/form-data',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/requests',
{
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/requests', 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/requests',
params: {
}, headers: headers
p JSON.parse(result)
POST /requests
This method is intended for working with DAAS Request API. Please use basePath - https://daas.checkhub.io/
Body parameter
documentTypeId: d3ccc75a-7f76-41f8-9ddf-c61622c8e091
files:
- There should be your file in binary format
metadata: {}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
documentTypeId | body | UUID_V4 | true | Unique identifier for the entity |
files | body | [string] | true | Daas request files |
metadata | body | object | false | This object will not be changed and you will receive it in the integration callback. Also you should be aware that these fields can be used in the rules during validation process |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"parserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validatorId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "finished",
"validation": [
{
"type": "or",
"action": "score",
"score": 10,
"sequence": 1,
"isValid": true,
"validations": [
{
"rule": "string",
"method": "contains",
"value": {
"value": "value"
},
"fieldName": "firstName",
"fieldValue": "Field value",
"sequence": 1,
"isValid": true
}
]
}
],
"validationStatus": "validated",
"data": {},
"metadata": {},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | daasRequest |
Get DAAS Request collection
Code samples
GET https://api.checkhub.io/requests HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/requests',
{
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/requests',
{
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/requests', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/requests',
params: {
}, headers: headers
p JSON.parse(result)
GET /requests
This method is intended for working with DAAS Request API. Please use basePath - https://daas.checkhub.io/
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
page | query | number | false | Page number of limited items. min: 1 , default: 1 |
limit | query | number | false | Maximum number of items in the response. min: 1 , max: 100 , default: 10 |
sort | query | string | false | Daas request collection sort |
direction | query | string | false | Daas request collection direction |
documentTypeId | query | UUID_V4 | false | Filter by request 'documentTypeId' field |
parserId | query | UUID_V4 | false | Filter by request 'parserId' field |
validatorId | query | UUID_V4 | false | Filter by request 'validatorId' field |
status | query | daasRequestStatus | false | Filter by request 'status' field |
statuses[] | query | array[string] | false | Filter result by custom statuses (or) |
validationStatus | query | daasRequestValidationStatus | false | Filter by request 'validationStatus' field |
createdAtFrom | query | DateISO | false | Filter result by creation time >= |
createdAtTo | query | DateISO | false | Filter result by creation time <= |
Enumerated Values
Parameter | Value |
---|---|
sort | createdAt |
direction | ASC |
direction | DESC |
status | accepted |
status | uploading_start |
status | uploading_end |
status | uploading_error |
status | converting_start |
status | converting_end |
status | converting_error |
status | combining_start |
status | combining_end |
status | combining_error |
status | parsing_start |
status | parsing_end |
status | parsing_error |
status | validation_start |
status | validation_end |
status | validation_error |
status | webhook_sending_start |
status | webhook_sending_end |
status | webhook_sending_error |
status | finished |
statuses[] | accepted |
statuses[] | uploading_start |
statuses[] | uploading_end |
statuses[] | uploading_error |
statuses[] | converting_start |
statuses[] | converting_end |
statuses[] | converting_error |
statuses[] | combining_start |
statuses[] | combining_end |
statuses[] | combining_error |
statuses[] | parsing_start |
statuses[] | parsing_end |
statuses[] | parsing_error |
statuses[] | validation_start |
statuses[] | validation_end |
statuses[] | validation_error |
statuses[] | webhook_sending_start |
statuses[] | webhook_sending_end |
statuses[] | webhook_sending_error |
statuses[] | finished |
validationStatus | validated |
validationStatus | pending |
validationStatus | rejected |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"parserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validatorId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "finished",
"validation": [
{
"type": "or",
"action": "score",
"score": 10,
"sequence": 1,
"isValid": true,
"validations": [
{
"rule": "string",
"method": "contains",
"value": {
"value": "value"
},
"fieldName": "firstName",
"fieldValue": "Field value",
"sequence": 1,
"isValid": true
}
]
}
],
"validationStatus": "validated",
"data": {},
"metadata": {},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | daasRequestArray |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
200 | X-CURRENT-PAGE | integer | Current page | |
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 DAAS Request by {{id}}
Code samples
GET https://api.checkhub.io/requests/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/requests/{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/requests/{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/requests/{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/requests/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /requests/{id}
This method is intended for working with DAAS Request API. Please use basePath - https://daas.checkhub.io/
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"parserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validatorId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "finished",
"validation": [
{
"type": "or",
"action": "score",
"score": 10,
"sequence": 1,
"isValid": true,
"validations": [
{
"rule": "string",
"method": "contains",
"value": {
"value": "value"
},
"fieldName": "firstName",
"fieldValue": "Field value",
"sequence": 1,
"isValid": true
}
]
}
],
"validationStatus": "validated",
"data": {},
"metadata": {},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | daasRequest |
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",
"reference": "dt_asap_eu",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"description": "Document Type description",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validationType": "auto",
"integrationSendOriginal": false,
"convertToPDF": false,
"isUnique": false,
"expiresInMonths": 2,
"isRectoVerso": false,
"advancedUploader": false,
"advancedUploaderSettings": {
"upload": false,
"scenario": "MrzAndLocate"
},
"skipBackup": 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",
"reference": "dt_asap_eu",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"description": "Document Type description",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validationType": "auto",
"integrationSendOriginal": false,
"convertToPDF": false,
"isUnique": false,
"expiresInMonths": 2,
"isRectoVerso": false,
"advancedUploader": false,
"advancedUploaderSettings": {
"upload": false,
"scenario": "MrzAndLocate"
},
"skipBackup": 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",
"reference": "dt_asap_eu",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"description": "Document Type description",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validationType": "auto",
"integrationSendOriginal": false,
"convertToPDF": false,
"isUnique": false,
"expiresInMonths": 2,
"isRectoVerso": false,
"advancedUploader": false,
"advancedUploaderSettings": {
"upload": false,
"scenario": "MrzAndLocate"
},
"skipBackup": 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 |
reference | body | string | false | Document type reference |
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 |
» it | body | string | false | none |
» pl | body | string | false | none |
» ro | body | string | false | none |
» sq | body | string | false | none |
» be | body | string | false | none |
» bg | body | string | false | none |
» hr | body | string | false | none |
» cs | body | string | false | none |
» da | body | string | false | none |
» et | body | string | false | none |
» fi | body | string | false | none |
» el | body | string | false | none |
» hu | body | string | false | none |
» is | body | string | false | none |
» ga | body | string | false | none |
» lv | body | string | false | none |
» lt | body | string | false | none |
» mk | body | string | false | none |
» mt | body | string | false | none |
» no | body | string | false | none |
» pt | body | string | false | none |
» ru | body | string | false | none |
» sr | body | string | false | none |
» sk | body | string | false | none |
» sl | body | string | false | none |
» es | body | string | false | none |
» sv | body | string | false | none |
» uk | body | string | false | none |
» cy | 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 |
advancedUploader | body | boolean | false | Enables additional logic for uploading recto-verso documents |
advancedUploaderSettings | body | object | false | Extended settings for advanced uploader |
skipBackup | body | boolean | false | If this option is true, it will exclude all candidate documents related to this type from our backup system. |
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",
"reference": "dt_asap_eu",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"description": "Document Type description",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validationType": "auto",
"integrationSendOriginal": false,
"convertToPDF": false,
"isUnique": false,
"expiresInMonths": 2,
"isRectoVerso": false,
"advancedUploader": false,
"advancedUploaderSettings": {
"upload": false,
"scenario": "MrzAndLocate"
},
"skipBackup": 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. min: 1 , max: 100 , default: 10 |
skip | query | number | false | Number of items skipped during the selection. min: 0 , default: 0 |
order | query | string | false | Document type collection order |
filter[ids][] | query | UUID_V4 | false | Search by document type ids |
filter[reference] | query | string | false | Search by document type reference |
filter[name] | query | string | false | Search by document type name |
filter[searchText] | query | string | false | Search by document type name + reference |
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",
"reference": "dt_asap_eu",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"description": "Document Type description",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validationType": "auto",
"integrationSendOriginal": false,
"convertToPDF": false,
"isUnique": false,
"expiresInMonths": 2,
"isRectoVerso": false,
"advancedUploader": false,
"advancedUploaderSettings": {
"upload": false,
"scenario": "MrzAndLocate"
},
"skipBackup": 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": "pending",
"ocrParsedData": {},
"validationSnapshot": {
"total": 10,
"totalToBePending": 10,
"conditions": [
{
"type": "or",
"action": "score",
"score": 10,
"sequence": 1,
"isValid": true,
"validations": [
{
"rule": "string",
"method": "contains",
"value": {
"value": "value"
},
"fieldName": "firstName",
"fieldValue": "Field value",
"sequence": 1,
"isValid": true
}
]
}
]
},
"integrationTransferedAt": "string",
"mergeSetFilePath": "string",
"isMultiple": false,
"isProcessing": false,
"isPaused": false,
"combinedMultipleDocumentPath": "string",
"combinedMultipleDocumentName": "string",
"expiresOn": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false
}
],
"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 should 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",
"reference": "dt_asap_eu",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"description": "Document Type description",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validationType": "auto",
"integrationSendOriginal": false,
"convertToPDF": false,
"isUnique": false,
"expiresInMonths": 2,
"isRectoVerso": false,
"advancedUploader": false,
"advancedUploaderSettings": {
"upload": false,
"scenario": "MrzAndLocate"
},
"skipBackup": 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",
"reference": "dt_asap_eu",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"description": "Document Type description",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validationType": "auto",
"integrationSendOriginal": false,
"convertToPDF": false,
"isUnique": false,
"expiresInMonths": 2,
"isRectoVerso": false,
"advancedUploader": false,
"advancedUploaderSettings": {
"upload": false,
"scenario": "MrzAndLocate"
},
"skipBackup": 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",
"reference": "dt_asap_eu",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"description": "Document Type description",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validationType": "auto",
"integrationSendOriginal": false,
"convertToPDF": false,
"isUnique": false,
"expiresInMonths": 2,
"isRectoVerso": false,
"advancedUploader": false,
"advancedUploaderSettings": {
"upload": false,
"scenario": "MrzAndLocate"
},
"skipBackup": 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",
"reference": "dt_asap_eu",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"description": "Document Type description",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validationType": "auto",
"integrationSendOriginal": false,
"convertToPDF": false,
"isUnique": false,
"expiresInMonths": 2,
"isRectoVerso": false,
"advancedUploader": false,
"advancedUploaderSettings": {
"upload": false,
"scenario": "MrzAndLocate"
},
"skipBackup": false
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be updated |
filename | body | string | false | Document type filename. It can include dynamic fields like {candidateFirstname} |
name | body | string | false | Document type name |
reference | body | string | false | Document type reference |
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 |
» it | body | string | false | none |
» pl | body | string | false | none |
» ro | body | string | false | none |
» sq | body | string | false | none |
» be | body | string | false | none |
» bg | body | string | false | none |
» hr | body | string | false | none |
» cs | body | string | false | none |
» da | body | string | false | none |
» et | body | string | false | none |
» fi | body | string | false | none |
» el | body | string | false | none |
» hu | body | string | false | none |
» is | body | string | false | none |
» ga | body | string | false | none |
» lv | body | string | false | none |
» lt | body | string | false | none |
» mk | body | string | false | none |
» mt | body | string | false | none |
» no | body | string | false | none |
» pt | body | string | false | none |
» ru | body | string | false | none |
» sr | body | string | false | none |
» sk | body | string | false | none |
» sl | body | string | false | none |
» es | body | string | false | none |
» sv | body | string | false | none |
» uk | body | string | false | none |
» cy | 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 |
advancedUploader | body | boolean | false | Enables additional logic for uploading recto-verso documents |
advancedUploaderSettings | body | object | false | Extended settings for advanced uploader |
skipBackup | body | boolean | false | If this option is true, it will exclude all candidate documents related to this type from our backup system. |
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",
"reference": "dt_asap_eu",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"description": "Document Type description",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validationType": "auto",
"integrationSendOriginal": false,
"convertToPDF": false,
"isUnique": false,
"expiresInMonths": 2,
"isRectoVerso": false,
"advancedUploader": false,
"advancedUploaderSettings": {
"upload": false,
"scenario": "MrzAndLocate"
},
"skipBackup": 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
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/documentTypes/{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/documentTypes/{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/documentTypes/{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/documentTypes/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /documentTypes/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be deleted |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | successfullyCompletedRequest |
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' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/documentValidationSets',
params: {
}, headers: headers
p JSON.parse(result)
GET /documentValidationSets
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response. min: 1 , max: 100 , default: 10 |
skip | query | number | false | Number of items skipped during the selection. min: 0 , default: 0 |
order | query | string | false | Document validation set collection order |
filter[name] | query | string | false | Search by document validation set name |
includeValidationGroups | query | boolean | false | To include document validation set 'validationGroups' relation |
includeValidationGroupsValidations | query | boolean | false | To include document validation set 'validationGroups' -> 'validations' 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",
"name": "ID card validation",
"scoreToBeValid": 10,
"scoreToBePending": 1,
"validations": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string"
}
]
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | documentValidationSetFindResponse |
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 a new document validation set
Code samples
POST https://api.checkhub.io/documentValidationSets HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"name": "ID card validation",
"scoreToBeValid": 10,
"scoreToBePending": 1,
"validationGroups": [
{
"validations": [
{
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string"
}
],
"type": "or",
"action": "score",
"score": 2,
"sequence": 1
}
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/documentValidationSets',
{
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": "ID card validation",
"scoreToBeValid": 10,
"scoreToBePending": 1,
"validationGroups": [
{
"validations": [
{
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string"
}
],
"type": "or",
"action": "score",
"score": 2,
"sequence": 1
}
]
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/documentValidationSets',
{
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/documentValidationSets', 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/documentValidationSets',
params: {
}, headers: headers
p JSON.parse(result)
POST /documentValidationSets
Body parameter
{
"name": "ID card validation",
"scoreToBeValid": 10,
"scoreToBePending": 1,
"validationGroups": [
{
"validations": [
{
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string"
}
],
"type": "or",
"action": "score",
"score": 2,
"sequence": 1
}
]
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
body | body | documentValidationSetCreate | false | none |
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": "ID card validation",
"scoreToBeValid": 10,
"scoreToBePending": 1
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | documentValidationSet |
Get document validation set by {{id}}
Code samples
GET https://api.checkhub.io/documentValidationSets/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/documentValidationSets/{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/documentValidationSets/{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/documentValidationSets/{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/documentValidationSets/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /documentValidationSets/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
includeValidationGroups | query | boolean | false | To include document validation set 'validationGroups' relation |
includeValidationGroupsValidations | query | boolean | false | To include document validation set 'validationGroups' -> 'validations' 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",
"name": "ID card validation",
"scoreToBeValid": 10,
"scoreToBePending": 1,
"validations": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string"
}
]
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | documentValidationSetFindByIdResponse |
Update document validation set by {{id}}
Code samples
PATCH https://api.checkhub.io/documentValidationSets/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"name": "ID card validation",
"scoreToBeValid": 10,
"scoreToBePending": 1,
"validationGroups": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validations": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string"
}
],
"type": "or",
"action": "score",
"score": 2,
"sequence": 1
}
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/documentValidationSets/{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": "ID card validation",
"scoreToBeValid": 10,
"scoreToBePending": 1,
"validationGroups": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validations": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string"
}
],
"type": "or",
"action": "score",
"score": 2,
"sequence": 1
}
]
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/documentValidationSets/{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/documentValidationSets/{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/documentValidationSets/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /documentValidationSets/{id}
Body parameter
{
"name": "ID card validation",
"scoreToBeValid": 10,
"scoreToBePending": 1,
"validationGroups": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validations": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string"
}
],
"type": "or",
"action": "score",
"score": 2,
"sequence": 1
}
]
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be updated |
body | body | documentValidationSetUpdate | false | none |
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": "ID card validation",
"scoreToBeValid": 10,
"scoreToBePending": 1
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | documentValidationSet |
Delete document validation set by {{id}}
Code samples
DELETE https://api.checkhub.io/documentValidationSets/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/documentValidationSets/{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/documentValidationSets/{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/documentValidationSets/{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/documentValidationSets/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /documentValidationSets/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be deleted |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | successfullyCompletedRequest |
Duplicate document validation set by {{id}}
Code samples
POST https://api.checkhub.io/documentValidationSets/{id}/duplicate HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/documentValidationSets/{id}/duplicate',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/documentValidationSets/{id}/duplicate',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.post('https://api.checkhub.io/documentValidationSets/{id}/duplicate', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.post 'https://api.checkhub.io/documentValidationSets/{id}/duplicate',
params: {
}, headers: headers
p JSON.parse(result)
POST /documentValidationSets/{id}/duplicate
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be duplicated |
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": "ID card validation",
"scoreToBeValid": 10,
"scoreToBePending": 1
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | documentValidationSet |
Document Validation Group
Get document validation group collection
Code samples
GET https://api.checkhub.io/document-validation-groups HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/document-validation-groups',
{
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/document-validation-groups',
{
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/document-validation-groups', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/document-validation-groups',
params: {
}, headers: headers
p JSON.parse(result)
GET /document-validation-groups
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response. min: 1 , max: 100 , default: 10 |
skip | query | number | false | Number of items skipped during the selection. min: 0 , default: 0 |
order | query | string | false | Document validation group collection order |
filter[documentValidationSetId] | query | UUID_V4 | false | Search by document validation set id |
includeDocumentValidationSet | query | boolean | false | To include document validation group 'documentValidationSet' relation |
Enumerated Values
Parameter | Value |
---|---|
order | sequence asc |
order | sequence desc |
order | createdAt asc |
order | createdAt desc |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"type": "or",
"action": "score",
"score": 2,
"sequence": 1,
"documentValidationSet": {
"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": "ID card validation",
"scoreToBeValid": 10,
"scoreToBePending": 1
}
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | documentValidationGroupFindResponse |
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 a new document validation group
Code samples
POST https://api.checkhub.io/document-validation-groups HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"type": "or",
"action": "score",
"score": 2,
"sequence": 1,
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validations": [
{
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string"
}
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/document-validation-groups',
{
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 = {
"type": "or",
"action": "score",
"score": 2,
"sequence": 1,
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validations": [
{
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string"
}
]
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/document-validation-groups',
{
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/document-validation-groups', 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/document-validation-groups',
params: {
}, headers: headers
p JSON.parse(result)
POST /document-validation-groups
Body parameter
{
"type": "or",
"action": "score",
"score": 2,
"sequence": 1,
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validations": [
{
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string"
}
]
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
type | body | string | false | Validation group type. It defines how group should be validated based on the related rules validations. |
action | body | string | false | Validation group action. It defines what should to do immediately after validation this group with rules. |
score | body | number | false | The number of points that document receives when passing this group of rules. |
sequence | body | number | false | The sequence number to show validation groups in appropriate order |
documentValidationSetId | body | UUID_V4 | true | Unique identifier for the entity |
validations | body | [documentValidationBase] | true | Array of document validations related to this validation group. Should be included min 1 item |
» fieldName | body | string | false | The name of the field in the parsing results |
» sequence | body | number | false | The sequence number to show validation rules in appropriate order |
» method | body | string | false | Validation method |
» value | body | object | false | Value for verification. (Not required for method notEmpty) |
» type | body | string | false | Validation type. It defines what should be expected field type. |
Enumerated Values
Parameter | Value |
---|---|
type | or |
type | and |
action | score |
action | rejectedDocument |
action | validatedDocument |
action | pendingDocument |
» method | empty |
» method | equally |
» method | contains |
» method | inList |
» method | notInList |
» method | notEqual |
» method | notEmpty |
» method | notContains |
» method | dateBetween |
» method | dateBeforeFixed |
» method | dateAfterFixed |
» method | dateBeforePeriod |
» method | dateAfterPeriod |
» method | faceMatchSimilarityMore |
» method | faceMatchSimilarityMoreOrEqual |
» method | faceMatchSimilarityLess |
» method | faceMatchSimilarityLessOrEqual |
» type | string |
» type | date |
» type | number |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"type": "or",
"action": "score",
"score": 2,
"sequence": 1
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | documentValidationGroup |
Update document validation groups
Code samples
PATCH https://api.checkhub.io/document-validation-groups HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '[
{
"type": "or",
"action": "score",
"score": 2,
"sequence": 1,
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/document-validation-groups',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = [
{
"type": "or",
"action": "score",
"score": 2,
"sequence": 1,
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
];
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/document-validation-groups',
{
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/document-validation-groups', 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/document-validation-groups',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /document-validation-groups
Body parameter
[
{
"type": "or",
"action": "score",
"score": 2,
"sequence": 1,
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be updated |
body | body | documentValidationGroupUpdate | false | none |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"type": "or",
"action": "score",
"score": 2,
"sequence": 1
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | documentValidationGroupArray |
Delete document validation groups
Code samples
DELETE https://api.checkhub.io/document-validation-groups 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/document-validation-groups',
{
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/document-validation-groups',
{
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/document-validation-groups', 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/document-validation-groups',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /document-validation-groups
Body parameter
{
"ids": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
ids | body | [UUID_V4] | false | Array of document validation group ids |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | successfullyCompletedRequest |
Create new document validation groups (bulk)
Code samples
POST https://api.checkhub.io/document-validation-groups/bulk HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '[
{
"type": "or",
"action": "score",
"score": 2,
"sequence": 1,
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validations": [
{
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string"
}
]
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/document-validation-groups/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 = [
{
"type": "or",
"action": "score",
"score": 2,
"sequence": 1,
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validations": [
{
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string"
}
]
}
];
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/document-validation-groups/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/document-validation-groups/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/document-validation-groups/bulk',
params: {
}, headers: headers
p JSON.parse(result)
POST /document-validation-groups/bulk
Body parameter
[
{
"type": "or",
"action": "score",
"score": 2,
"sequence": 1,
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validations": [
{
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string"
}
]
}
]
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
body | body | documentValidationGroupCreate | false | none |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"type": "or",
"action": "score",
"score": 2,
"sequence": 1
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | documentValidationGroupArray |
Get document validation group by {{id}}
Code samples
GET https://api.checkhub.io/document-validation-groups/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/document-validation-groups/{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/document-validation-groups/{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/document-validation-groups/{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/document-validation-groups/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /document-validation-groups/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
includeDocumentValidationSet | query | boolean | false | To include document validation group 'documentValidationSet' relation |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"type": "or",
"action": "score",
"score": 2,
"sequence": 1,
"documentValidationSet": {
"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": "ID card validation",
"scoreToBeValid": 10,
"scoreToBePending": 1
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | documentValidationGroupFindByIdResponse |
Update document validation group by {{id}}
Code samples
PATCH https://api.checkhub.io/document-validation-groups/{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/document-validation-groups/{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 = {};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/document-validation-groups/{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/document-validation-groups/{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/document-validation-groups/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /document-validation-groups/{id}
Body parameter
{}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be updated |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"type": "or",
"action": "score",
"score": 2,
"sequence": 1
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | documentValidationGroup |
Delete document validation group by {{id}}
Code samples
DELETE https://api.checkhub.io/document-validation-groups/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/document-validation-groups/{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/document-validation-groups/{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/document-validation-groups/{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/document-validation-groups/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /document-validation-groups/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be deleted |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | successfullyCompletedRequest |
Document Validation
Get document validation collection
Code samples
GET https://api.checkhub.io/documentValidations HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/documentValidations',
{
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/documentValidations',
{
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/documentValidations', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/documentValidations',
params: {
}, headers: headers
p JSON.parse(result)
GET /documentValidations
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response. min: 1 , max: 100 , default: 10 |
skip | query | number | false | Number of items skipped during the selection. min: 0 , default: 0 |
order | query | string | false | Document validation collection order |
filter[method] | query | string | false | Search by document validation method |
filter[fieldName] | query | string | false | Search by document validation field name |
filter[documentValidationSetId] | query | UUID_V4 | false | Search by document validation set id |
filter[documentValidationGroupId] | query | UUID_V4 | false | Search by document validation group id |
includeDocumentValidationSet | query | boolean | false | To include document validation 'documentValidationSet' relation |
includeDocumentValidationGroup | query | boolean | false | To include document validation 'documentValidationGroup' relation |
Enumerated Values
Parameter | Value |
---|---|
order | fieldName asc |
order | fieldName desc |
order | score asc |
order | score desc |
order | createdAt asc |
order | createdAt desc |
filter[method] | empty |
filter[method] | equally |
filter[method] | contains |
filter[method] | inList |
filter[method] | notInList |
filter[method] | notEqual |
filter[method] | notEmpty |
filter[method] | notContains |
filter[method] | dateBetween |
filter[method] | dateBeforeFixed |
filter[method] | dateAfterFixed |
filter[method] | dateBeforePeriod |
filter[method] | dateAfterPeriod |
filter[method] | faceMatchSimilarityMore |
filter[method] | faceMatchSimilarityMoreOrEqual |
filter[method] | faceMatchSimilarityLess |
filter[method] | faceMatchSimilarityLessOrEqual |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string",
"documentValidationSet": {
"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": "ID card validation",
"scoreToBeValid": 10,
"scoreToBePending": 1
},
"documentValidationGroup": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"type": "or",
"action": "score",
"score": 2,
"sequence": 1
}
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | documentValidationFindResponse |
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 a new document validation
Code samples
POST https://api.checkhub.io/documentValidations HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/documentValidations',
{
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 = {
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/documentValidations',
{
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/documentValidations', 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/documentValidations',
params: {
}, headers: headers
p JSON.parse(result)
POST /documentValidations
Body parameter
{
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
fieldName | body | string | true | The name of the field in the parsing results |
sequence | body | number | false | The sequence number to show validation rules in appropriate order |
method | body | string | true | Validation method |
value | body | object | true | Value for verification. (Not required for method notEmpty) |
type | body | string | false | Validation type. It defines what should be expected field type. |
documentValidationSetId | body | UUID_V4 | true | Unique identifier for the entity |
documentValidationGroupId | body | UUID_V4 | true | Unique identifier for the entity |
Enumerated Values
Parameter | Value |
---|---|
method | empty |
method | equally |
method | contains |
method | inList |
method | notInList |
method | notEqual |
method | notEmpty |
method | notContains |
method | dateBetween |
method | dateBeforeFixed |
method | dateAfterFixed |
method | dateBeforePeriod |
method | dateAfterPeriod |
method | faceMatchSimilarityMore |
method | faceMatchSimilarityMoreOrEqual |
method | faceMatchSimilarityLess |
method | faceMatchSimilarityLessOrEqual |
type | string |
type | date |
type | number |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | documentValidation |
Update document validations
Code samples
PATCH https://api.checkhub.io/documentValidations HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '[
{
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/documentValidations',
{
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 = [
{
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
];
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/documentValidations',
{
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/documentValidations', 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/documentValidations',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /documentValidations
Body parameter
[
{
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be updated |
body | body | documentValidationUpdate | false | none |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string"
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | documentValidationArray |
Delete document validations
Code samples
DELETE https://api.checkhub.io/documentValidations 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/documentValidations',
{
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/documentValidations',
{
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/documentValidations', 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/documentValidations',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /documentValidations
Body parameter
{
"ids": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
ids | body | [UUID_V4] | false | Array of document validation ids |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | successfullyCompletedRequest |
Create new document validations (bulk)
Code samples
POST https://api.checkhub.io/documentValidations/bulk HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '[
{
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/documentValidations/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 = [
{
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
];
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/documentValidations/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/documentValidations/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/documentValidations/bulk',
params: {
}, headers: headers
p JSON.parse(result)
POST /documentValidations/bulk
Body parameter
[
{
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
body | body | documentValidationCreate | false | none |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string"
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | documentValidationArray |
Get document validation by {{id}}
Code samples
GET https://api.checkhub.io/documentValidations/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/documentValidations/{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/documentValidations/{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/documentValidations/{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/documentValidations/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /documentValidations/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
includeDocumentValidationSet | query | boolean | false | To include document validation 'documentValidationSet' relation |
includeDocumentValidationGroup | query | boolean | false | To include document validation 'documentValidationGroup' relation |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string",
"documentValidationSet": {
"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": "ID card validation",
"scoreToBeValid": 10,
"scoreToBePending": 1
},
"documentValidationGroup": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"type": "or",
"action": "score",
"score": 2,
"sequence": 1
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | documentValidationFindByIdResponse |
Update document validation by {{id}}
Code samples
PATCH https://api.checkhub.io/documentValidations/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/documentValidations/{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 = {
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/documentValidations/{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/documentValidations/{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/documentValidations/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /documentValidations/{id}
Body parameter
{
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be updated |
fieldName | body | string | false | The name of the field in the parsing results |
sequence | body | number | false | The sequence number to show validation rules in appropriate order |
method | body | string | false | Validation method |
value | body | object | false | Value for verification. (Not required for method notEmpty) |
type | body | string | false | Validation type. It defines what should be expected field type. |
Enumerated Values
Parameter | Value |
---|---|
method | empty |
method | equally |
method | contains |
method | inList |
method | notInList |
method | notEqual |
method | notEmpty |
method | notContains |
method | dateBetween |
method | dateBeforeFixed |
method | dateAfterFixed |
method | dateBeforePeriod |
method | dateAfterPeriod |
method | faceMatchSimilarityMore |
method | faceMatchSimilarityMoreOrEqual |
method | faceMatchSimilarityLess |
method | faceMatchSimilarityLessOrEqual |
type | string |
type | date |
type | number |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | documentValidation |
Delete document validation by {{id}}
Code samples
DELETE https://api.checkhub.io/documentValidations/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/documentValidations/{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/documentValidations/{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/documentValidations/{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/documentValidations/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /documentValidations/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be deleted |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | successfullyCompletedRequest |
Form
Create Form
Code samples
POST https://api.checkhub.io/forms HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"name": "Work Permit",
"reference": "work_permit",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"filename": "initial_{candidateFirstname}",
"language": "en",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"isPdfGenerationEnabled": false
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/forms',
{
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": "Work Permit",
"reference": "work_permit",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"filename": "initial_{candidateFirstname}",
"language": "en",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"isPdfGenerationEnabled": false
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/forms',
{
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/forms', 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/forms',
params: {
}, headers: headers
p JSON.parse(result)
POST /forms
Body parameter
{
"name": "Work Permit",
"reference": "work_permit",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"filename": "initial_{candidateFirstname}",
"language": "en",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"isPdfGenerationEnabled": false
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
name | body | string | true | Form name |
reference | body | string | false | Form reference |
signatureId | body | UUID_V4 | false | Unique identifier for the entity |
additionId | body | UUID_V4 | false | Unique identifier for the entity |
fileId | body | UUID_V4 | false | Unique identifier for the entity |
filename | body | string | true | Form file name |
language | body | formLanguage | true | One of Form language enumeration |
actions | body | [formAction] | true | Form actions (at least one action required); Please note that allowable actions depend on the type of the original form:
|
isMandatory | body | boolean | false | Is Form mandatory |
isPreliminary | body | boolean | false | Is Form preliminary |
isBlocking | body | boolean | false | Is the candidate screen blocking by the form popup |
isPdfGenerationEnabled | body | boolean | false | Is Form PDF generation enabled |
Enumerated Values
Parameter | Value |
---|---|
language | en |
language | fr |
language | nl |
language | de |
language | it |
language | pl |
language | ro |
language | sq |
language | be |
language | bg |
language | hr |
language | cs |
language | da |
language | et |
language | fi |
language | el |
language | hu |
language | is |
language | ga |
language | lv |
language | lt |
language | mk |
language | mt |
language | no |
language | pt |
language | ru |
language | sr |
language | sk |
language | sl |
language | es |
language | sv |
language | uk |
language | cy |
actions | read |
actions | complete |
actions | eSign |
actions | download |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Work Permit",
"reference": "work_permit",
"shareCode": "",
"type": "editable",
"language": "en",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"updatedById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | form |
Get Form Collection
Code samples
GET https://api.checkhub.io/forms HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/forms',
{
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/forms',
{
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/forms', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/forms',
params: {
}, headers: headers
p JSON.parse(result)
GET /forms
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response. min: 1 , max: 100 , default: 10 |
skip | query | number | false | Number of items skipped during the selection. min: 0 , default: 0 |
order | query | string | false | Form collection order |
filter[searchText] | query | string | false | Form Partial search by text of form name or reference |
filter[name] | query | string | false | Find forms by name |
filter[reference] | query | string | false | Find forms by reference |
filter[languages][] | query | string | false | Filter forms by languages |
filter[types][] | query | string | false | Filter forms by types |
includeAddition | query | boolean | false | You can include form 'addition' relation |
includeFile | query | boolean | false | You can include form 'file' relation |
includeProfile | query | boolean | false | You can include form 'profile' relation |
includeTypes | query | boolean | false | You can include form 'types' relation |
includeIndustries | query | boolean | false | You can include form 'industries' relation |
includeCreatedBy | query | boolean | false | You can include form 'createdBy' relation |
includeUpdatedBy | query | boolean | false | You can include form 'updatedBy' relation |
Enumerated Values
Parameter | Value |
---|---|
order | name asc |
order | name desc |
filter[languages][] | en |
filter[languages][] | fr |
filter[languages][] | nl |
filter[languages][] | de |
filter[languages][] | it |
filter[languages][] | pl |
filter[languages][] | ro |
filter[languages][] | sq |
filter[languages][] | be |
filter[languages][] | bg |
filter[languages][] | hr |
filter[languages][] | cs |
filter[languages][] | da |
filter[languages][] | et |
filter[languages][] | fi |
filter[languages][] | el |
filter[languages][] | hu |
filter[languages][] | is |
filter[languages][] | ga |
filter[languages][] | lv |
filter[languages][] | lt |
filter[languages][] | mk |
filter[languages][] | mt |
filter[languages][] | no |
filter[languages][] | pt |
filter[languages][] | ru |
filter[languages][] | sr |
filter[languages][] | sk |
filter[languages][] | sl |
filter[languages][] | es |
filter[languages][] | sv |
filter[languages][] | uk |
filter[languages][] | cy |
filter[types][] | readonly |
filter[types][] | editable |
filter[types][] | file |
filter[types][] | combo |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Work Permit",
"reference": "work_permit",
"shareCode": "",
"type": "editable",
"language": "en",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"updatedById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"createdBy": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"lastActivityAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"isOwner": false
},
"updatedBy": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"lastActivityAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"isOwner": false
},
"addition": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"sequence": 1,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | formFindResponse |
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 Form by {{id}}
Code samples
GET https://api.checkhub.io/forms/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/forms/{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/forms/{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/forms/{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/forms/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /forms/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
includeAddition | query | boolean | false | You can include form 'addition' relation |
includeFile | query | boolean | false | You can include form 'file' relation |
includeProfile | query | boolean | false | You can include form 'profile' relation |
includeTypes | query | boolean | false | You can include form 'types' relation |
includeIndustries | query | boolean | false | You can include form 'industries' relation |
includeCreatedBy | query | boolean | false | You can include form 'createdBy' relation |
includeUpdatedBy | query | boolean | false | You can include form 'updatedBy' relation |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Work Permit",
"reference": "work_permit",
"shareCode": "",
"type": "editable",
"language": "en",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"updatedById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"createdBy": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"lastActivityAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"isOwner": false
},
"updatedBy": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"lastActivityAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"isOwner": false
},
"addition": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"sequence": 1,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | formFindByIdResponse |
Delete Form by {{id}}
Code samples
DELETE https://api.checkhub.io/forms/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/forms/{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/forms/{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/forms/{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/forms/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /forms/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be deleted |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | formSuccessResponse |
Update Form by {{id}}
Code samples
PATCH https://api.checkhub.io/forms/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"name": "Work Permit",
"reference": "work_permit",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"filename": "initial_{candidateFirstname}",
"language": "en",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"isPdfGenerationEnabled": false
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/forms/{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": "Work Permit",
"reference": "work_permit",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"filename": "initial_{candidateFirstname}",
"language": "en",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"isPdfGenerationEnabled": false
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/forms/{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/forms/{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/forms/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /forms/{id}
Body parameter
{
"name": "Work Permit",
"reference": "work_permit",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"filename": "initial_{candidateFirstname}",
"language": "en",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"isPdfGenerationEnabled": false
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be updated |
name | body | string | false | Form name |
reference | body | string | false | Form reference |
signatureId | body | UUID_V4 | false | Unique identifier for the entity |
additionId | body | UUID_V4 | false | Unique identifier for the entity |
fileId | body | UUID_V4 | false | Unique identifier for the entity |
filename | body | string | false | Form file name |
language | body | formLanguage | false | One of Form language enumeration |
actions | body | [formAction] | false | Form actions (at least one action required); Please note that allowable actions depend on the type of the original form:
|
isMandatory | body | boolean | false | Is Form mandatory |
isPreliminary | body | boolean | false | Is Form preliminary |
isBlocking | body | boolean | false | Is the candidate screen blocking by the form popup |
isPdfGenerationEnabled | body | boolean | false | Is Form PDF generation enabled |
Enumerated Values
Parameter | Value |
---|---|
language | en |
language | fr |
language | nl |
language | de |
language | it |
language | pl |
language | ro |
language | sq |
language | be |
language | bg |
language | hr |
language | cs |
language | da |
language | et |
language | fi |
language | el |
language | hu |
language | is |
language | ga |
language | lv |
language | lt |
language | mk |
language | mt |
language | no |
language | pt |
language | ru |
language | sr |
language | sk |
language | sl |
language | es |
language | sv |
language | uk |
language | cy |
actions | read |
actions | complete |
actions | eSign |
actions | download |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Work Permit",
"reference": "work_permit",
"shareCode": "",
"type": "editable",
"language": "en",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"updatedById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | form |
Duplicate Form
Code samples
POST https://api.checkhub.io/forms/{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/forms/{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/forms/{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/forms/{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/forms/{id}/duplicate',
params: {
}, headers: headers
p JSON.parse(result)
POST /forms/{id}/duplicate
Body parameter
{}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Work Permit",
"reference": "work_permit",
"shareCode": "",
"type": "editable",
"language": "en",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"updatedById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | form |
File
Get file collection
Code samples
GET https://api.checkhub.io/files HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/files',
{
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/files',
{
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/files', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/files',
params: {
}, headers: headers
p JSON.parse(result)
GET /files
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response. min: 1 , max: 100 , default: 10 |
skip | query | number | false | Number of items skipped during the selection. min: 0 , default: 0 |
order | query | string | false | File collection order |
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",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | fileFindResponse |
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. |
Upload Company File.
Code samples
POST https://api.checkhub.io/files HTTP/1.1
Host: api.checkhub.io
Content-Type: multipart/form-data
Accept: application/json
const inputBody = '{
"file": "There should be your file in binary format",
"isPublic": false,
"storage": "internal"
}';
const headers = {
'Content-Type':'multipart/form-data',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/files',
{
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 = {
"file": "There should be your file in binary format",
"isPublic": false,
"storage": "internal"
};
const headers = {
'Content-Type':'multipart/form-data',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/files',
{
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/files', 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/files',
params: {
}, headers: headers
p JSON.parse(result)
POST /files
Body parameter
file: There should be your file in binary format
isPublic: false
storage: internal
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
file | body | string(binary) | true | File to be uploaded. It should have allowed content type |
isPublic | body | boolean | false | Is public file |
storage | body | fileStorage | false | none |
Enumerated Values
Parameter | Value |
---|---|
storage | internal |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | file |
Get file by {{id}}
Code samples
GET https://api.checkhub.io/files/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/files/{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/files/{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/files/{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/files/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /files/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | fileFindByIdResponse |
Integration
Create a new Integration.
Code samples
POST https://api.checkhub.io/integrations HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"isAllAccounts": false,
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllForms": false,
"forms": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"name": "string",
"triggerEvent": "candidateCompleted",
"type": "push",
"isActive": false,
"connectionData": {
"url": "string",
"headers": {}
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/integrations',
{
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 = {
"isAllAccounts": false,
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllForms": false,
"forms": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"name": "string",
"triggerEvent": "candidateCompleted",
"type": "push",
"isActive": false,
"connectionData": {
"url": "string",
"headers": {}
}
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/integrations',
{
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/integrations', 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/integrations',
params: {
}, headers: headers
p JSON.parse(result)
POST /integrations
Body parameter
{
"isAllAccounts": false,
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllForms": false,
"forms": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"name": "string",
"triggerEvent": "candidateCompleted",
"type": "push",
"isActive": false,
"connectionData": {
"url": "string",
"headers": {}
}
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
isAllAccounts | body | boolean | true | Integration will be assigned to all company accounts. |
accounts | body | [UUID_V4] | false | Array of related accounts. |
isAllForms | body | boolean | false | Form related integration will be assigned to all company forms. |
forms | body | [UUID_V4] | false | Forms array of form related integrations. |
name | body | string | true | Integration name |
triggerEvent | body | integrationTriggerEvent | true | none |
type | body | integrationType | true | none |
isActive | body | boolean | true | Integration will be active or inactive. |
connectionData | body | object | true | Integration connection data. |
» url | body | string | false | POST data will be send to external url address. For example - 'https://c713.m.example.net' |
» headers | body | object | false | Integration connection data headers |
Enumerated Values
Parameter | Value |
---|---|
triggerEvent | formCompleted |
triggerEvent | formSigned |
triggerEvent | resourceCompleted |
triggerEvent | daasFileParsed |
triggerEvent | candidateUploadedFile |
triggerEvent | candidateUploadedFileRejected |
triggerEvent | candidateUploadedFileValidated |
triggerEvent | candidateCreated |
triggerEvent | candidateUpdated |
triggerEvent | candidateCompleted |
triggerEvent | candidateDeleted |
type | zapier |
type | push |
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",
"isAllAccounts": false,
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllForms": false,
"forms": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"name": "string",
"triggerEvent": "candidateCompleted",
"type": "push",
"isActive": false,
"connectionData": {
"url": "string",
"headers": {}
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | integration |
Get integration collection
Code samples
GET https://api.checkhub.io/integrations HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/integrations',
{
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/integrations',
{
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/integrations', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/integrations',
params: {
}, headers: headers
p JSON.parse(result)
GET /integrations
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response. min: 1 , max: 100 , default: 10 |
skip | query | number | false | Number of items skipped during the selection. min: 0 , default: 0 |
order | query | string | false | Integration collection order |
filter[name] | query | string | false | Filter by candidate 'name' field |
filter[type] | query | integrationType | false | Filter by candidate 'type' field |
filter[triggerEvent] | query | integrationTriggerEvent | false | Filter by candidate 'triggerEvent' field |
Enumerated Values
Parameter | Value |
---|---|
order | name asc |
order | name desc |
order | createdAt asc |
order | createdAt desc |
filter[type] | zapier |
filter[type] | push |
filter[triggerEvent] | formCompleted |
filter[triggerEvent] | formSigned |
filter[triggerEvent] | resourceCompleted |
filter[triggerEvent] | daasFileParsed |
filter[triggerEvent] | candidateUploadedFile |
filter[triggerEvent] | candidateUploadedFileRejected |
filter[triggerEvent] | candidateUploadedFileValidated |
filter[triggerEvent] | candidateCreated |
filter[triggerEvent] | candidateUpdated |
filter[triggerEvent] | candidateCompleted |
filter[triggerEvent] | candidateDeleted |
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",
"isAllAccounts": false,
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllForms": false,
"forms": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"name": "string",
"triggerEvent": "candidateCompleted",
"type": "push",
"isActive": false,
"connectionData": {
"url": "string",
"headers": {}
}
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | integrationFindResponse |
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 integration by {{id}}
Code samples
GET https://api.checkhub.io/integrations/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/integrations/{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/integrations/{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/integrations/{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/integrations/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /integrations/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"isAllAccounts": false,
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllForms": false,
"forms": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"name": "string",
"triggerEvent": "candidateCompleted",
"type": "push",
"isActive": false,
"connectionData": {
"url": "string",
"headers": {}
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | integration |
Update integration by {{id}}
Code samples
PATCH https://api.checkhub.io/integrations/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"isAllAccounts": false,
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllForms": false,
"forms": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"name": "string",
"triggerEvent": "candidateCompleted",
"type": "push",
"isActive": false,
"connectionData": {
"url": "string",
"headers": {}
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/integrations/{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 = {
"isAllAccounts": false,
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllForms": false,
"forms": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"name": "string",
"triggerEvent": "candidateCompleted",
"type": "push",
"isActive": false,
"connectionData": {
"url": "string",
"headers": {}
}
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/integrations/{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/integrations/{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/integrations/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /integrations/{id}
Body parameter
{
"isAllAccounts": false,
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllForms": false,
"forms": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"name": "string",
"triggerEvent": "candidateCompleted",
"type": "push",
"isActive": false,
"connectionData": {
"url": "string",
"headers": {}
}
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be updated |
isAllAccounts | body | boolean | false | Integration will be assigned to all company accounts. |
accounts | body | [UUID_V4] | false | Array of related accounts. |
isAllForms | body | boolean | false | Form related integration will be assigned to all company forms. |
forms | body | [UUID_V4] | false | Forms array of form related integrations. |
name | body | string | false | Integration name |
triggerEvent | body | integrationTriggerEvent | false | none |
type | body | integrationType | false | none |
isActive | body | boolean | false | Integration will be active or inactive. |
connectionData | body | object | false | Integration connection data. |
» url | body | string | false | POST data will be send to external url address. For example - 'https://c713.m.example.net' |
» headers | body | object | false | Integration connection data headers |
Enumerated Values
Parameter | Value |
---|---|
triggerEvent | formCompleted |
triggerEvent | formSigned |
triggerEvent | resourceCompleted |
triggerEvent | daasFileParsed |
triggerEvent | candidateUploadedFile |
triggerEvent | candidateUploadedFileRejected |
triggerEvent | candidateUploadedFileValidated |
triggerEvent | candidateCreated |
triggerEvent | candidateUpdated |
triggerEvent | candidateCompleted |
triggerEvent | candidateDeleted |
type | zapier |
type | push |
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",
"isAllAccounts": false,
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllForms": false,
"forms": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"name": "string",
"triggerEvent": "candidateCompleted",
"type": "push",
"isActive": false,
"connectionData": {
"url": "string",
"headers": {}
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | integration |
Delete integration by {{id}}
Code samples
DELETE https://api.checkhub.io/integrations/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/integrations/{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/integrations/{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/integrations/{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/integrations/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /integrations/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be deleted |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | successfullyCompletedRequest |
Get integration log collection
Code samples
GET https://api.checkhub.io/integrations/logs HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/integrations/logs',
{
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/integrations/logs',
{
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/integrations/logs', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/integrations/logs',
params: {
}, headers: headers
p JSON.parse(result)
GET /integrations/logs
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response. min: 1 , max: 100 , default: 10 |
skip | query | number | false | Number of items skipped during the selection. min: 0 , default: 0 |
order | query | string | false | Integration log collection order |
Enumerated Values
Parameter | Value |
---|---|
order | createdAt asc |
order | createdAt desc |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"author": "string",
"description": "string",
"type": "string",
"status": "string",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"name": "Welcome letter",
"templateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"reference": "WELCOME_EN_DE_CREATED",
"delayInHours": 0,
"eventName": "candidateCreated",
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"languages": [
"en",
"fr",
"nl"
],
"recipients": {
"candidate": {
"enabled": true
},
"creator": {
"enabled": true
},
"customEmail": {
"enabled": true,
"email": "[email protected]"
},
"customFields": {
"enabled": true,
"fieldIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}
},
"replyTo": {
"type": "default",
"value": "[email protected]"
},
"isActive": true,
"tagsCondition": "or"
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | integrationLogsFindResponse |
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. |
Count integration logs
Code samples
GET https://api.checkhub.io/integrations/logs/count HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/integrations/logs/count',
{
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/integrations/logs/count',
{
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/integrations/logs/count', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/integrations/logs/count',
params: {
}, headers: headers
p JSON.parse(result)
GET /integrations/logs/count
Example responses
200 Response
{
"total": 0
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | integrationLogsCountResponse |
Send Integration Init request
Code samples
POST https://api.checkhub.io/integrations/send-init-request HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"url": "string",
"headers": {},
"triggerEvent": "candidateCompleted",
"type": "push"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/integrations/send-init-request',
{
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 = {
"url": "string",
"headers": {},
"triggerEvent": "candidateCompleted",
"type": "push"
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/integrations/send-init-request',
{
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/integrations/send-init-request', 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/integrations/send-init-request',
params: {
}, headers: headers
p JSON.parse(result)
POST /integrations/send-init-request
You can use this request to test sending integration data. Please check integration example data https://doc.checkhub.io//#schemaintegrationexamplesdata
Body parameter
{
"url": "string",
"headers": {},
"triggerEvent": "candidateCompleted",
"type": "push"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
url | body | string | true | POST data will be send to external url address. For example - 'https://c713.m.example.net' |
headers | body | object | false | Integration connection data headers |
triggerEvent | body | integrationTriggerEvent | true | none |
type | body | integrationType | true | none |
Enumerated Values
Parameter | Value |
---|---|
triggerEvent | formCompleted |
triggerEvent | formSigned |
triggerEvent | resourceCompleted |
triggerEvent | daasFileParsed |
triggerEvent | candidateUploadedFile |
triggerEvent | candidateUploadedFileRejected |
triggerEvent | candidateUploadedFileValidated |
triggerEvent | candidateCreated |
triggerEvent | candidateUpdated |
triggerEvent | candidateCompleted |
triggerEvent | candidateDeleted |
type | zapier |
type | push |
Example responses
200 Response
{
"info": "",
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | integrationSendInitRequestResponse |
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. min: 1 , max: 100 , default: 10 |
skip | query | number | false | Number of items skipped during the selection. min: 0 , default: 0 |
order | query | string | false | 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[languages][] | it |
filter[languages][] | pl |
filter[languages][] | ro |
filter[languages][] | sq |
filter[languages][] | be |
filter[languages][] | bg |
filter[languages][] | hr |
filter[languages][] | cs |
filter[languages][] | da |
filter[languages][] | et |
filter[languages][] | fi |
filter[languages][] | el |
filter[languages][] | hu |
filter[languages][] | is |
filter[languages][] | ga |
filter[languages][] | lv |
filter[languages][] | lt |
filter[languages][] | mk |
filter[languages][] | mt |
filter[languages][] | no |
filter[languages][] | pt |
filter[languages][] | ru |
filter[languages][] | sr |
filter[languages][] | sk |
filter[languages][] | sl |
filter[languages][] | es |
filter[languages][] | sv |
filter[languages][] | uk |
filter[languages][] | cy |
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 should 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 should 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
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/resources/{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/resources/{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/resources/{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/resources/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /resources/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be deleted |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | 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 should 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 should 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
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/resources/{id}/unshare',
{
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/resources/{id}/unshare',
{
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/resources/{id}/unshare', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'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
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | 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 |
Registration Page
Get Registration Page collection
Code samples
GET https://api.checkhub.io/registration-pages HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/registration-pages',
{
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/registration-pages',
{
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/registration-pages', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/registration-pages',
params: {
}, headers: headers
p JSON.parse(result)
GET /registration-pages
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response. min: 1 , max: 100 , default: 10 |
skip | query | number | false | Number of items skipped during the selection. min: 0 , default: 0 |
order | query | string | false | Registration Page collection order |
filter[searchText] | query | string | false | Registration Page Partial search by text of form name |
filter[languages][] | query | string | false | Filter registration pages by languages |
includeAccount | query | boolean | false | Include Registration Page Account 'account' relation |
includeDocuments | query | boolean | false | Include Registration Page Documents 'documents' relation |
includeDocumentsDocumentType | query | boolean | false | Include Registration Page Documents with embedded Document Type 'documents[0].documentType' relation |
includeForms | query | boolean | false | Include Registration Page Forms 'forms' relation |
includeFormsForm | query | boolean | false | Include Registration Page Forms with embedded Form 'forms[0].form' relation |
includeTags | query | boolean | false | Include Registration Page Tags 'tags' relation |
includeTagsTag | query | boolean | false | Include Registration Page Tags with embedded Tag 'tags[0].tag' relation |
includeFields | query | boolean | false | Include Registration Page Fields 'fields' relation |
includeFieldsCustomField | query | boolean | false | Include Registration Page Fields with embedded Custom Field 'fields[0].customField' relation |
includeStatistic | query | boolean | false | Include Registration Page Statistic 'statistic' relation |
includeShare | query | boolean | false | Include Registration Page Share 'share' relation |
Enumerated Values
Parameter | Value |
---|---|
order | name asc |
order | name desc |
order | createdAt asc |
order | createdAt desc |
order | isActive asc |
order | isActive desc |
filter[languages][] | en |
filter[languages][] | fr |
filter[languages][] | nl |
filter[languages][] | de |
filter[languages][] | it |
filter[languages][] | pl |
filter[languages][] | ro |
filter[languages][] | sq |
filter[languages][] | be |
filter[languages][] | bg |
filter[languages][] | hr |
filter[languages][] | cs |
filter[languages][] | da |
filter[languages][] | et |
filter[languages][] | fi |
filter[languages][] | el |
filter[languages][] | hu |
filter[languages][] | is |
filter[languages][] | ga |
filter[languages][] | lv |
filter[languages][] | lt |
filter[languages][] | mk |
filter[languages][] | mt |
filter[languages][] | no |
filter[languages][] | pt |
filter[languages][] | ru |
filter[languages][] | sr |
filter[languages][] | sk |
filter[languages][] | sl |
filter[languages][] | es |
filter[languages][] | sv |
filter[languages][] | uk |
filter[languages][] | cy |
Example responses
200 Response
{
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"themeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "string",
"language": "en",
"token": "8f2b44db61bb96e6",
"isActive": false,
"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",
"account": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"aboutText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedBoxText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"documents": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"registrationPageId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "string",
"comment": "string",
"commentType": "info",
"isMandatory": false,
"folder": "string",
"documentType": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"name": "ASAP",
"reference": "dt_asap_eu",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"description": "Document Type description",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validationType": "auto",
"integrationSendOriginal": false,
"convertToPDF": false,
"isUnique": false,
"expiresInMonths": 2,
"isRectoVerso": false,
"advancedUploader": false,
"advancedUploaderSettings": {
"upload": false,
"scenario": "MrzAndLocate"
},
"skipBackup": false
}
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"registrationPageId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "string",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"form": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Work Permit",
"reference": "work_permit",
"shareCode": "",
"type": "editable",
"language": "en",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"updatedById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
}
],
"fields": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"registrationPageId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "string",
"reference": "string",
"isMandatory": false,
"isBase": false,
"sequence": 0,
"customField": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Document Number",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"reference": "DOC_NUM",
"fieldType": "string",
"description": "This custom field is required to store the passport series.",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"visibilityRules": {
"admin": {
"visible": true,
"editable": true,
"mandatory": false
},
"candidate": {
"visible": true,
"editable": true,
"mandatory": false
}
},
"accountIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"docTypeIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"orderNbr": 3
}
}
],
"tags": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"registrationPageId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"tag": {
"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",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"registrationPageId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"viewsTotal": 0,
"submissionsTotal": 0
},
"share": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"registrationPageId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"qrCodeFileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"link": "https://register.dev.checkhub.io/79a365e745024b6c"
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | registrationPageFindResponse |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
200 | X-CURRENT-PAGE | integer | Current page | |
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 Registration Page by {{id}}
Code samples
GET https://api.checkhub.io/registration-pages/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/registration-pages/{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/registration-pages/{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/registration-pages/{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/registration-pages/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /registration-pages/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
includeAccount | query | boolean | false | Include Registration Page Account 'account' relation |
includeDocuments | query | boolean | false | Include Registration Page Documents 'documents' relation |
includeDocumentsDocumentType | query | boolean | false | Include Registration Page Documents with embedded Document Type 'documents[0].documentType' relation |
includeForms | query | boolean | false | Include Registration Page Forms 'forms' relation |
includeFormsForm | query | boolean | false | Include Registration Page Forms with embedded Form 'forms[0].form' relation |
includeTags | query | boolean | false | Include Registration Page Tags 'tags' relation |
includeTagsTag | query | boolean | false | Include Registration Page Tags with embedded Tag 'tags[0].tag' relation |
includeFields | query | boolean | false | Include Registration Page Fields 'fields' relation |
includeFieldsCustomField | query | boolean | false | Include Registration Page Fields with embedded Custom Field 'fields[0].customField' relation |
includeStatistic | query | boolean | false | Include Registration Page Statistic 'statistic' relation |
includeShare | query | boolean | false | Include Registration Page Share 'share' relation |
Example responses
200 Response
{
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"themeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "string",
"language": "en",
"token": "8f2b44db61bb96e6",
"isActive": false,
"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",
"account": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"aboutText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedBoxText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"documents": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"registrationPageId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "string",
"comment": "string",
"commentType": "info",
"isMandatory": false,
"folder": "string",
"documentType": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"name": "ASAP",
"reference": "dt_asap_eu",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"description": "Document Type description",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validationType": "auto",
"integrationSendOriginal": false,
"convertToPDF": false,
"isUnique": false,
"expiresInMonths": 2,
"isRectoVerso": false,
"advancedUploader": false,
"advancedUploaderSettings": {
"upload": false,
"scenario": "MrzAndLocate"
},
"skipBackup": false
}
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"registrationPageId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "string",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"form": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Work Permit",
"reference": "work_permit",
"shareCode": "",
"type": "editable",
"language": "en",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"updatedById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
}
],
"fields": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"registrationPageId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "string",
"reference": "string",
"isMandatory": false,
"isBase": false,
"sequence": 0,
"customField": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Document Number",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"reference": "DOC_NUM",
"fieldType": "string",
"description": "This custom field is required to store the passport series.",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"visibilityRules": {
"admin": {
"visible": true,
"editable": true,
"mandatory": false
},
"candidate": {
"visible": true,
"editable": true,
"mandatory": false
}
},
"accountIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"docTypeIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"orderNbr": 3
}
}
],
"tags": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"registrationPageId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"tag": {
"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",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"registrationPageId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"viewsTotal": 0,
"submissionsTotal": 0
},
"share": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"registrationPageId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"qrCodeFileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"link": "https://register.dev.checkhub.io/79a365e745024b6c"
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | registrationPageFindByIdResponse |
Scenario
Get scenario collection
Code samples
GET https://api.checkhub.io/scenarios HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/scenarios',
{
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/scenarios',
{
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/scenarios', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/scenarios',
params: {
}, headers: headers
p JSON.parse(result)
GET /scenarios
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response. min: 1 , max: 100 , default: 10 |
skip | query | number | false | Number of items skipped during the selection. min: 0 , default: 0 |
order | query | string | false | Scenario collection order |
filter[name] | query | string | false | Search by scenario name |
filter[reference] | query | string | false | Search by scenario reference |
filter[isActive] | query | boolean | false | Search by scenario state |
filter[languages][] | query | string | false | Search by scenario languages (or) |
filter[events][] | query | string | false | Search by scenario events (or) |
filter[accountIds][] | query | UUID_V4 | false | Search by account ids (or) |
includeTags | query | boolean | false | To include scenario 'tags' relation |
includeCompany | query | boolean | false | To include scenario 'company' relation |
includeTemplate | query | boolean | false | To include scenario 'template' relation |
Enumerated Values
Parameter | Value |
---|---|
order | name asc |
order | name desc |
order | createdAt asc |
order | createdAt desc |
order | isActive asc |
order | isActive desc |
filter[languages][] | en |
filter[languages][] | fr |
filter[languages][] | nl |
filter[languages][] | de |
filter[languages][] | it |
filter[languages][] | pl |
filter[languages][] | ro |
filter[languages][] | sq |
filter[languages][] | be |
filter[languages][] | bg |
filter[languages][] | hr |
filter[languages][] | cs |
filter[languages][] | da |
filter[languages][] | et |
filter[languages][] | fi |
filter[languages][] | el |
filter[languages][] | hu |
filter[languages][] | is |
filter[languages][] | ga |
filter[languages][] | lv |
filter[languages][] | lt |
filter[languages][] | mk |
filter[languages][] | mt |
filter[languages][] | no |
filter[languages][] | pt |
filter[languages][] | ru |
filter[languages][] | sr |
filter[languages][] | sk |
filter[languages][] | sl |
filter[languages][] | es |
filter[languages][] | sv |
filter[languages][] | uk |
filter[languages][] | cy |
filter[events][] | candidateCreated |
filter[events][] | candidatePending |
filter[events][] | candidateCompleted |
filter[events][] | candidateCompletedWithFlows |
filter[events][] | candidateManualNotification |
filter[events][] | candidateUploadedFile |
filter[events][] | candidateUploadedFileRejected |
filter[events][] | candidateUploadedFileValidated |
filter[events][] | candidateUploadedFilePending |
filter[events][] | candidateDocumentExpired |
filter[events][] | nextSerialSignature |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypes": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"name": "ASAP",
"reference": "dt_asap_eu",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"description": "Document Type description",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validationType": "auto",
"integrationSendOriginal": false,
"convertToPDF": false,
"isUnique": false,
"expiresInMonths": 2,
"isRectoVerso": false,
"advancedUploader": false,
"advancedUploaderSettings": {
"upload": false,
"scenario": "MrzAndLocate"
},
"skipBackup": false
}
],
"tags": [
{
"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"
}
],
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Welcome letter",
"templateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"reference": "WELCOME_EN_DE_CREATED",
"delayInHours": 0,
"eventName": "candidateCreated",
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"languages": [
"en",
"fr",
"nl"
],
"recipients": {
"candidate": {
"enabled": true
},
"creator": {
"enabled": true
},
"customEmail": {
"enabled": true,
"email": "[email protected]"
},
"customFields": {
"enabled": true,
"fieldIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}
},
"replyTo": {
"type": "default",
"value": "[email protected]"
},
"isActive": true,
"tagsCondition": "or",
"company": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it",
"pl",
"ro",
"sq",
"be",
"bg",
"hr",
"cs",
"da",
"et",
"fi",
"el",
"hu",
"is",
"ga",
"lv",
"lt",
"mk",
"mt",
"no",
"pt",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"uk",
"cy"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
},
"template": {
"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": "ASAP",
"type": "email",
"email": {
"editor": "tinymce",
"subject": "Welcome to Tesla!",
"content": "<div>Welcome to Tesla! </div><div>Here is your link for adding documents: `{link}`</div>",
"design": {},
"css": ".welcome {\n font-size: 25px;\n}"
},
"sms": {
"content": "Welcome to Tesla!\n Here is your link for adding documents: ..."
}
}
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | scenarioFindResponse |
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 scenario
Code samples
POST https://api.checkhub.io/scenarios HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"name": "Welcome letter",
"templateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"reference": "WELCOME_EN_DE_CREATED",
"delayInHours": 0,
"eventName": "candidateCreated",
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"languages": [
"en",
"fr",
"nl"
],
"recipients": {
"candidate": {
"enabled": true
},
"creator": {
"enabled": true
},
"customEmail": {
"enabled": true,
"email": "[email protected]"
},
"customFields": {
"enabled": true,
"fieldIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}
},
"replyTo": {
"type": "default",
"value": "[email protected]"
},
"isActive": true,
"tagsCondition": "or",
"tags": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"documentTypes": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/scenarios',
{
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 letter",
"templateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"reference": "WELCOME_EN_DE_CREATED",
"delayInHours": 0,
"eventName": "candidateCreated",
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"languages": [
"en",
"fr",
"nl"
],
"recipients": {
"candidate": {
"enabled": true
},
"creator": {
"enabled": true
},
"customEmail": {
"enabled": true,
"email": "[email protected]"
},
"customFields": {
"enabled": true,
"fieldIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}
},
"replyTo": {
"type": "default",
"value": "[email protected]"
},
"isActive": true,
"tagsCondition": "or",
"tags": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"documentTypes": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/scenarios',
{
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/scenarios', 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/scenarios',
params: {
}, headers: headers
p JSON.parse(result)
POST /scenarios
Body parameter
{
"name": "Welcome letter",
"templateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"reference": "WELCOME_EN_DE_CREATED",
"delayInHours": 0,
"eventName": "candidateCreated",
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"languages": [
"en",
"fr",
"nl"
],
"recipients": {
"candidate": {
"enabled": true
},
"creator": {
"enabled": true
},
"customEmail": {
"enabled": true,
"email": "[email protected]"
},
"customFields": {
"enabled": true,
"fieldIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}
},
"replyTo": {
"type": "default",
"value": "[email protected]"
},
"isActive": true,
"tagsCondition": "or",
"tags": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"documentTypes": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
name | body | string | true | Scenario name |
templateId | body | UUID_V4 | true | Unique identifier for the entity |
reference | body | string | true | Scenario reference |
delayInHours | body | number | false | Delay in sending after the event is triggered (only for candidatePending) |
eventName | body | scenarioEvent | true | Scenario event type |
accounts | body | [UUID_V4] | false | Accounts for which this scenario will work. |
languages | body | [scenarioLanguage] | true | The set of languages for which the scenario can be executed. |
recipients | body | scenarioRecipients | true | Options for who will receive notifications. |
» candidate | body | object | true | The candidate for whom the scenario worked. |
»» enabled | body | boolean | false | none |
» creator | body | object | true | The user who created the candidate. |
»» enabled | body | boolean | false | none |
» customEmail | body | object | true | none |
»» enabled | body | boolean | false | none |
body | string(email) | false | Any email address. It will be used if customEmail.enabled is true |
|
» customFields | body | object | true | none |
»» enabled | body | boolean | false | none |
»» fieldIds | body | [UUID_V4] | false | Ids of candidate custom fields with type email. |
replyTo | body | scenarioReplyTo | false | Scenario notifications replyTo options. |
» type | body | scenarioReplyToType | true | Scenario reply to type |
» value | body | string | false | Scenario replyTo valid email value. It is required only for following types (customField, custom) |
isActive | body | boolean | false | Is the scenario enabled |
tagsCondition | body | scenarioTagsCondition | false | Conditions for added tags. |
tags | body | [UUID_V4] | false | Scenario tag ids |
documentTypes | body | [UUID_V4] | false | Scenario document type ids |
Enumerated Values
Parameter | Value |
---|---|
eventName | candidateCreated |
eventName | candidatePending |
eventName | candidateCompleted |
eventName | candidateCompletedWithFlows |
eventName | candidateManualNotification |
eventName | candidateUploadedFile |
eventName | candidateUploadedFileRejected |
eventName | candidateUploadedFileValidated |
eventName | candidateUploadedFilePending |
eventName | candidateDocumentExpired |
eventName | nextSerialSignature |
languages | en |
languages | fr |
languages | nl |
languages | de |
languages | it |
languages | pl |
languages | ro |
languages | sq |
languages | be |
languages | bg |
languages | hr |
languages | cs |
languages | da |
languages | et |
languages | fi |
languages | el |
languages | hu |
languages | is |
languages | ga |
languages | lv |
languages | lt |
languages | mk |
languages | mt |
languages | no |
languages | pt |
languages | ru |
languages | sr |
languages | sk |
languages | sl |
languages | es |
languages | sv |
languages | uk |
languages | cy |
» type | default |
» type | candidateCreator |
» type | customField |
» type | custom |
tagsCondition | or |
tagsCondition | and |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypes": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"name": "ASAP",
"reference": "dt_asap_eu",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"description": "Document Type description",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validationType": "auto",
"integrationSendOriginal": false,
"convertToPDF": false,
"isUnique": false,
"expiresInMonths": 2,
"isRectoVerso": false,
"advancedUploader": false,
"advancedUploaderSettings": {
"upload": false,
"scenario": "MrzAndLocate"
},
"skipBackup": false
}
],
"tags": [
{
"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"
}
],
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Welcome letter",
"templateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"reference": "WELCOME_EN_DE_CREATED",
"delayInHours": 0,
"eventName": "candidateCreated",
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"languages": [
"en",
"fr",
"nl"
],
"recipients": {
"candidate": {
"enabled": true
},
"creator": {
"enabled": true
},
"customEmail": {
"enabled": true,
"email": "[email protected]"
},
"customFields": {
"enabled": true,
"fieldIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}
},
"replyTo": {
"type": "default",
"value": "[email protected]"
},
"isActive": true,
"tagsCondition": "or"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | scenario |
Get scenario by {{id}}
Code samples
GET https://api.checkhub.io/scenarios/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/scenarios/{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/scenarios/{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/scenarios/{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/scenarios/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /scenarios/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
includeTags | query | boolean | false | To include scenario 'tags' relation |
includeCompany | query | boolean | false | To include scenario 'company' relation |
includeTemplate | query | boolean | false | To include scenario 'template' relation |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypes": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"name": "ASAP",
"reference": "dt_asap_eu",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"description": "Document Type description",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validationType": "auto",
"integrationSendOriginal": false,
"convertToPDF": false,
"isUnique": false,
"expiresInMonths": 2,
"isRectoVerso": false,
"advancedUploader": false,
"advancedUploaderSettings": {
"upload": false,
"scenario": "MrzAndLocate"
},
"skipBackup": false
}
],
"tags": [
{
"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"
}
],
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Welcome letter",
"templateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"reference": "WELCOME_EN_DE_CREATED",
"delayInHours": 0,
"eventName": "candidateCreated",
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"languages": [
"en",
"fr",
"nl"
],
"recipients": {
"candidate": {
"enabled": true
},
"creator": {
"enabled": true
},
"customEmail": {
"enabled": true,
"email": "[email protected]"
},
"customFields": {
"enabled": true,
"fieldIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}
},
"replyTo": {
"type": "default",
"value": "[email protected]"
},
"isActive": true,
"tagsCondition": "or",
"company": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it",
"pl",
"ro",
"sq",
"be",
"bg",
"hr",
"cs",
"da",
"et",
"fi",
"el",
"hu",
"is",
"ga",
"lv",
"lt",
"mk",
"mt",
"no",
"pt",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"uk",
"cy"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
},
"template": {
"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": "ASAP",
"type": "email",
"email": {
"editor": "tinymce",
"subject": "Welcome to Tesla!",
"content": "<div>Welcome to Tesla! </div><div>Here is your link for adding documents: `{link}`</div>",
"design": {},
"css": ".welcome {\n font-size: 25px;\n}"
},
"sms": {
"content": "Welcome to Tesla!\n Here is your link for adding documents: ..."
}
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | scenarioFindByIdResponse |
Update scenario by {{id}}
Code samples
PATCH https://api.checkhub.io/scenarios/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"name": "Welcome letter",
"templateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"reference": "WELCOME_EN_DE_CREATED",
"delayInHours": 0,
"eventName": "candidateCreated",
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"languages": [
"en",
"fr",
"nl"
],
"recipients": {
"candidate": {
"enabled": true
},
"creator": {
"enabled": true
},
"customEmail": {
"enabled": true,
"email": "[email protected]"
},
"customFields": {
"enabled": true,
"fieldIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}
},
"replyTo": {
"type": "default",
"value": "[email protected]"
},
"isActive": true,
"tagsCondition": "or",
"tags": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"documentTypes": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/scenarios/{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 letter",
"templateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"reference": "WELCOME_EN_DE_CREATED",
"delayInHours": 0,
"eventName": "candidateCreated",
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"languages": [
"en",
"fr",
"nl"
],
"recipients": {
"candidate": {
"enabled": true
},
"creator": {
"enabled": true
},
"customEmail": {
"enabled": true,
"email": "[email protected]"
},
"customFields": {
"enabled": true,
"fieldIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}
},
"replyTo": {
"type": "default",
"value": "[email protected]"
},
"isActive": true,
"tagsCondition": "or",
"tags": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"documentTypes": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/scenarios/{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/scenarios/{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/scenarios/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /scenarios/{id}
Body parameter
{
"name": "Welcome letter",
"templateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"reference": "WELCOME_EN_DE_CREATED",
"delayInHours": 0,
"eventName": "candidateCreated",
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"languages": [
"en",
"fr",
"nl"
],
"recipients": {
"candidate": {
"enabled": true
},
"creator": {
"enabled": true
},
"customEmail": {
"enabled": true,
"email": "[email protected]"
},
"customFields": {
"enabled": true,
"fieldIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}
},
"replyTo": {
"type": "default",
"value": "[email protected]"
},
"isActive": true,
"tagsCondition": "or",
"tags": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"documentTypes": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be updated |
name | body | string | false | Scenario name |
templateId | body | UUID_V4 | false | Unique identifier for the entity |
reference | body | string | false | Scenario reference |
delayInHours | body | number | false | Delay in sending after the event is triggered (only for candidatePending) |
eventName | body | scenarioEvent | false | Scenario event type |
accounts | body | [UUID_V4] | false | Accounts for which this scenario will work. |
languages | body | [scenarioLanguage] | false | The set of languages for which the scenario can be executed. |
recipients | body | scenarioRecipients | false | Options for who will receive notifications. |
» candidate | body | object | true | The candidate for whom the scenario worked. |
»» enabled | body | boolean | false | none |
» creator | body | object | true | The user who created the candidate. |
»» enabled | body | boolean | false | none |
» customEmail | body | object | true | none |
»» enabled | body | boolean | false | none |
body | string(email) | false | Any email address. It will be used if customEmail.enabled is true |
|
» customFields | body | object | true | none |
»» enabled | body | boolean | false | none |
»» fieldIds | body | [UUID_V4] | false | Ids of candidate custom fields with type email. |
replyTo | body | scenarioReplyTo | false | Scenario notifications replyTo options. |
» type | body | scenarioReplyToType | true | Scenario reply to type |
» value | body | string | false | Scenario replyTo valid email value. It is required only for following types (customField, custom) |
isActive | body | boolean | false | Is the scenario enabled |
tagsCondition | body | scenarioTagsCondition | false | Conditions for added tags. |
tags | body | [UUID_V4] | false | Scenario tag ids |
documentTypes | body | [UUID_V4] | false | Scenario document type ids |
Enumerated Values
Parameter | Value |
---|---|
eventName | candidateCreated |
eventName | candidatePending |
eventName | candidateCompleted |
eventName | candidateCompletedWithFlows |
eventName | candidateManualNotification |
eventName | candidateUploadedFile |
eventName | candidateUploadedFileRejected |
eventName | candidateUploadedFileValidated |
eventName | candidateUploadedFilePending |
eventName | candidateDocumentExpired |
eventName | nextSerialSignature |
languages | en |
languages | fr |
languages | nl |
languages | de |
languages | it |
languages | pl |
languages | ro |
languages | sq |
languages | be |
languages | bg |
languages | hr |
languages | cs |
languages | da |
languages | et |
languages | fi |
languages | el |
languages | hu |
languages | is |
languages | ga |
languages | lv |
languages | lt |
languages | mk |
languages | mt |
languages | no |
languages | pt |
languages | ru |
languages | sr |
languages | sk |
languages | sl |
languages | es |
languages | sv |
languages | uk |
languages | cy |
» type | default |
» type | candidateCreator |
» type | customField |
» type | custom |
tagsCondition | or |
tagsCondition | and |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypes": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"name": "ASAP",
"reference": "dt_asap_eu",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"description": "Document Type description",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validationType": "auto",
"integrationSendOriginal": false,
"convertToPDF": false,
"isUnique": false,
"expiresInMonths": 2,
"isRectoVerso": false,
"advancedUploader": false,
"advancedUploaderSettings": {
"upload": false,
"scenario": "MrzAndLocate"
},
"skipBackup": false
}
],
"tags": [
{
"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"
}
],
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Welcome letter",
"templateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"reference": "WELCOME_EN_DE_CREATED",
"delayInHours": 0,
"eventName": "candidateCreated",
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"languages": [
"en",
"fr",
"nl"
],
"recipients": {
"candidate": {
"enabled": true
},
"creator": {
"enabled": true
},
"customEmail": {
"enabled": true,
"email": "[email protected]"
},
"customFields": {
"enabled": true,
"fieldIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}
},
"replyTo": {
"type": "default",
"value": "[email protected]"
},
"isActive": true,
"tagsCondition": "or"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | scenario |
Delete scenario by {{id}}
Code samples
DELETE https://api.checkhub.io/scenarios/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/scenarios/{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/scenarios/{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/scenarios/{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/scenarios/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /scenarios/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be deleted |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | successfullyCompletedRequest |
Trigger scenario manually
Code samples
POST https://api.checkhub.io/scenarios/initiate-manually HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"scenarioId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"custom": {
"email": {
"subject": "Your personal access",
"content": "<div>Hey John</div>",
"withContentWrapper": true,
"sender": {
"email": "[email protected]",
"replyTo": "[email protected]",
"name": "Sender Name"
}
},
"sms": {
"content": "Your personal access link: "
}
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/scenarios/initiate-manually',
{
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 = {
"scenarioId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"custom": {
"email": {
"subject": "Your personal access",
"content": "<div>Hey John</div>",
"withContentWrapper": true,
"sender": {
"email": "[email protected]",
"replyTo": "[email protected]",
"name": "Sender Name"
}
},
"sms": {
"content": "Your personal access link: "
}
}
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/scenarios/initiate-manually',
{
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/scenarios/initiate-manually', 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/scenarios/initiate-manually',
params: {
}, headers: headers
p JSON.parse(result)
POST /scenarios/initiate-manually
Body parameter
{
"scenarioId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"custom": {
"email": {
"subject": "Your personal access",
"content": "<div>Hey John</div>",
"withContentWrapper": true,
"sender": {
"email": "[email protected]",
"replyTo": "[email protected]",
"name": "Sender Name"
}
},
"sms": {
"content": "Your personal access link: "
}
}
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
body | body | scenarioInitiateManually | false | none |
Example responses
200 Response
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"scenarioId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"templateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"method": "email",
"partNbr": 1,
"triggerType": "automatic",
"webhooks": "string",
"uniqueEventId": "string",
"target": "[email protected]",
"delayedSending": "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 | scenarioInitiateManuallyResponse |
Storage
Download candidate document
Code samples
GET https://api.checkhub.io/storages/candidate-document/{candidateDocumentId}/download HTTP/1.1
Host: api.checkhub.io
Accept: application/pdf
const headers = {
'Accept':'application/pdf',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/storages/candidate-document/{candidateDocumentId}/download',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/pdf',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/storages/candidate-document/{candidateDocumentId}/download',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/pdf',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/storages/candidate-document/{candidateDocumentId}/download', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/pdf',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/storages/candidate-document/{candidateDocumentId}/download',
params: {
}, headers: headers
p JSON.parse(result)
GET /storages/candidate-document/{candidateDocumentId}/download
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
candidateDocumentId | path | UUID_V4 | true | The candidate's document Id for download. |
type | query | string | false | Scenario collection order |
Enumerated Values
Parameter | Value |
---|---|
type | |
type | mergeSet |
type |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | File with the appropriate type as specified in the query type. (applciation/pdf for pdf and mergeSet or any other mime-type for original file) |
downloadFileResponse |
Download candidate document type
Code samples
GET https://api.checkhub.io/storages/candidate-document-type/{candidateDocumentTypeId}/download HTTP/1.1
Host: api.checkhub.io
Accept: application/pdf
const headers = {
'Accept':'application/pdf',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/storages/candidate-document-type/{candidateDocumentTypeId}/download',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/pdf',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/storages/candidate-document-type/{candidateDocumentTypeId}/download',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/pdf',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/storages/candidate-document-type/{candidateDocumentTypeId}/download', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/pdf',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/storages/candidate-document-type/{candidateDocumentTypeId}/download',
params: {
}, headers: headers
p JSON.parse(result)
GET /storages/candidate-document-type/{candidateDocumentTypeId}/download
The method is used only to download combined files (containing 2 or more candidate documents)
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
candidateDocumentTypeId | path | UUID_V4 | true | The candidate's document type Id for download. |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Combined pdf file with all related candidate documents. | downloadFileResponse |
Download candidate form
Code samples
GET https://api.checkhub.io/storages/candidate-form/{candidateFormId}/download HTTP/1.1
Host: api.checkhub.io
Accept: application/pdf
const headers = {
'Accept':'application/pdf',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/storages/candidate-form/{candidateFormId}/download',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/pdf',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/storages/candidate-form/{candidateFormId}/download',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/pdf',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/storages/candidate-form/{candidateFormId}/download', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/pdf',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/storages/candidate-form/{candidateFormId}/download',
params: {
}, headers: headers
p JSON.parse(result)
GET /storages/candidate-form/{candidateFormId}/download
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
candidateFormId | path | UUID_V4 | true | The candidate's form Id for download. |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Candidate form. application/pdf for text forms. Or a mime-type corresponding to the file type in form with attached file. |
downloadFileResponse |
Download candidate form (by candidate)
Code samples
GET https://api.checkhub.io/storages/candidate-form/{candidateFormId}/download-candidate HTTP/1.1
Host: api.checkhub.io
Accept: application/pdf
const headers = {
'Accept':'application/pdf',
'X-CSRF-TOKEN':'API_KEY'
};
fetch('https://api.checkhub.io/storages/candidate-form/{candidateFormId}/download-candidate',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/pdf',
'X-CSRF-TOKEN':'API_KEY'
};
fetch('https://api.checkhub.io/storages/candidate-form/{candidateFormId}/download-candidate',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/pdf',
'X-CSRF-TOKEN': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/storages/candidate-form/{candidateFormId}/download-candidate', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/pdf',
'X-CSRF-TOKEN' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/storages/candidate-form/{candidateFormId}/download-candidate',
params: {
}, headers: headers
p JSON.parse(result)
GET /storages/candidate-form/{candidateFormId}/download-candidate
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
candidateFormId | path | UUID_V4 | true | The candidate's form Id for download. |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Candidate form. application/pdf for text forms. Or a mime-type corresponding to the file type in form with attached file. |
downloadFileResponse |
Download candidate resource
Code samples
GET https://api.checkhub.io/storages/candidate-resource/{candidateResourceId}/download HTTP/1.1
Host: api.checkhub.io
Accept: application/pdf
const headers = {
'Accept':'application/pdf',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/storages/candidate-resource/{candidateResourceId}/download',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/pdf',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/storages/candidate-resource/{candidateResourceId}/download',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/pdf',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/storages/candidate-resource/{candidateResourceId}/download', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/pdf',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/storages/candidate-resource/{candidateResourceId}/download',
params: {
}, headers: headers
p JSON.parse(result)
GET /storages/candidate-resource/{candidateResourceId}/download
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
candidateResourceId | path | UUID_V4 | true | The candidate's resource Id for download. |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Candidate resource. application/pdf for text resources. Or a mime-type corresponding to the file type in resource with attached file. |
downloadFileResponse |
Download candidate resource (by candidate)
Code samples
GET https://api.checkhub.io/storages/candidate-resource/{candidateResourceId}/download-candidate HTTP/1.1
Host: api.checkhub.io
Accept: application/pdf
const headers = {
'Accept':'application/pdf',
'X-CSRF-TOKEN':'API_KEY'
};
fetch('https://api.checkhub.io/storages/candidate-resource/{candidateResourceId}/download-candidate',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/pdf',
'X-CSRF-TOKEN':'API_KEY'
};
fetch('https://api.checkhub.io/storages/candidate-resource/{candidateResourceId}/download-candidate',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/pdf',
'X-CSRF-TOKEN': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/storages/candidate-resource/{candidateResourceId}/download-candidate', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/pdf',
'X-CSRF-TOKEN' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/storages/candidate-resource/{candidateResourceId}/download-candidate',
params: {
}, headers: headers
p JSON.parse(result)
GET /storages/candidate-resource/{candidateResourceId}/download-candidate
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
candidateResourceId | path | UUID_V4 | true | The candidate's resource Id for download. |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Candidate resource. application/pdf for text resources. Or a mime-type corresponding to the file type in resource with attached file. |
downloadFileResponse |
Download all files which related to candidate in ZIP.
Code samples
GET https://api.checkhub.io/storages/candidate/{candidateId}/download HTTP/1.1
Host: api.checkhub.io
Accept: application/zip
const headers = {
'Accept':'application/zip',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/storages/candidate/{candidateId}/download',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/zip',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/storages/candidate/{candidateId}/download',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/zip',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/storages/candidate/{candidateId}/download', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/zip',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/storages/candidate/{candidateId}/download',
params: {
}, headers: headers
p JSON.parse(result)
GET /storages/candidate/{candidateId}/download
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
candidateId | path | UUID_V4 | true | The candidate Id for download. |
pdfOnly | query | boolean | false | Whether the archive should contain only PDF files |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Zip archive which contains files and resources of the candidate. | string |
Download original resource by id
Code samples
GET https://api.checkhub.io/storages/resource/{resourceId}/download HTTP/1.1
Host: api.checkhub.io
Accept: application/pdf
const headers = {
'Accept':'application/pdf',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/storages/resource/{resourceId}/download',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/pdf',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/storages/resource/{resourceId}/download',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/pdf',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/storages/resource/{resourceId}/download', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/pdf',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/storages/resource/{resourceId}/download',
params: {
}, headers: headers
p JSON.parse(result)
GET /storages/resource/{resourceId}/download
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
resourceId | path | UUID_V4 | true | The resource Id for download. |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Resource attached file | downloadFileResponse |
Download company file
Code samples
GET https://api.checkhub.io/storages/file/{fileId}/download HTTP/1.1
Host: api.checkhub.io
Accept: application/pdf
const headers = {
'Accept':'application/pdf',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/storages/file/{fileId}/download',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/pdf',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/storages/file/{fileId}/download',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/pdf',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/storages/file/{fileId}/download', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/pdf',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/storages/file/{fileId}/download',
params: {
}, headers: headers
p JSON.parse(result)
GET /storages/file/{fileId}/download
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
fileId | path | UUID_V4 | true | The candidate's file Id for download. |
Example responses
200 Response
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Company file. | downloadFileResponse |
Signature
Get signature collection
Code samples
GET https://api.checkhub.io/signatures HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/signatures',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/signatures',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/signatures', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/signatures',
params: {
}, headers: headers
p JSON.parse(result)
GET /signatures
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response. min: 1 , max: 100 , default: 10 |
skip | query | number | false | Number of items skipped during the selection. min: 0 , default: 0 |
order | query | string | false | Signature collection order |
filter[searchText] | query | string | false | Search by signature name |
filter[isSerial] | query | boolean | false | Search by signature isSerial flag |
includeProvider | query | boolean | false | To include signature provider |
includeProviderTheme | query | boolean | false | To include signature provider theme |
includeRoles | query | boolean | false | To include signature roles |
includeRolesDefinition | query | boolean | false | To include signature roles definition |
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",
"isSerial": false,
"methods": [
"string"
],
"defaultMethod": "string",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"providerId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"description": "",
"provider": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"themeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"provider": ""
},
"roles": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"roleId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isActive": true,
"sequence": 0,
"sendSignedFile": true,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | signatureFindResponse |
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 signature
Code samples
POST https://api.checkhub.io/signatures HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"providerId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"description": "",
"roles": [
{
"roleId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isActive": false,
"sendSignedFile": false,
"sequence": 0
}
],
"isSerial": false
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/signatures',
{
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 = {
"providerId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"description": "",
"roles": [
{
"roleId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isActive": false,
"sendSignedFile": false,
"sequence": 0
}
],
"isSerial": false
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/signatures',
{
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/signatures', 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/signatures',
params: {
}, headers: headers
p JSON.parse(result)
POST /signatures
Body parameter
{
"providerId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"description": "",
"roles": [
{
"roleId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isActive": false,
"sendSignedFile": false,
"sequence": 0
}
],
"isSerial": false
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
providerId | body | UUID_V4 | true | Unique identifier for the entity |
name | body | string | true | Signature name |
description | body | string | false | Signature name |
roles | body | [signatureCreateRole] | true | Signature Create Roles. |
» roleId | body | UUID_V4 | true | Unique identifier for the entity |
» isActive | body | boolean | true | Is serial signature |
» sendSignedFile | body | boolean | false | It is needed only for 'candidate' role to send signed file over the email sending |
» sequence | body | number | false | Set only if signature is serial. It should be started from 0 |
isSerial | body | boolean | false | Is serial signature |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isSerial": false,
"methods": [
"string"
],
"defaultMethod": "string",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"providerId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"description": ""
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | signature |
Get signature by {{id}}
Code samples
GET https://api.checkhub.io/signatures/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/signatures/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/signatures/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/signatures/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/signatures/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /signatures/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
includeProvider | query | boolean | false | To include signature provider |
includeProviderTheme | query | boolean | false | To include signature provider theme |
includeRoles | query | boolean | false | To include signature roles |
includeRolesDefinition | query | boolean | false | To include signature roles definition |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isSerial": false,
"methods": [
"string"
],
"defaultMethod": "string",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"providerId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"description": "",
"provider": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"themeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"provider": ""
},
"roles": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"roleId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isActive": true,
"sequence": 0,
"sendSignedFile": true,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | signatureFindByIdResponse |
Update signature by {{id}}
Code samples
PATCH https://api.checkhub.io/signatures/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"providerId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"description": ""
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/signatures/{id}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const inputBody = {
"providerId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"description": ""
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/signatures/{id}',
{
method: 'PATCH',
body: JSON.stringify(inputBody),
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.patch('https://api.checkhub.io/signatures/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.patch 'https://api.checkhub.io/signatures/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /signatures/{id}
Body parameter
{
"providerId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"description": ""
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be updated |
providerId | body | UUID_V4 | false | Unique identifier for the entity |
name | body | string | false | Signature name |
description | body | string | false | Signature name |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isSerial": false,
"methods": [
"string"
],
"defaultMethod": "string",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"providerId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"description": ""
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | signature |
Delete signature by {{id}}
Code samples
DELETE https://api.checkhub.io/signatures/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/signatures/{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/signatures/{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/signatures/{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/signatures/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /signatures/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be deleted |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | successfullyCompletedRequest |
Duplicate Signature
Code samples
POST https://api.checkhub.io/signatures/{id}/copy 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/signatures/{id}/copy',
{
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/signatures/{id}/copy',
{
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/signatures/{id}/copy', 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/signatures/{id}/copy',
params: {
}, headers: headers
p JSON.parse(result)
POST /signatures/{id}/copy
Body parameter
{}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be duplicated |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isSerial": false,
"methods": [
"string"
],
"defaultMethod": "string",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"providerId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"description": ""
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | signature |
Signature Provider
Get signature provider collection
Code samples
GET https://api.checkhub.io/signature-providers HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/signature-providers',
{
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/signature-providers',
{
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/signature-providers', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/signature-providers',
params: {
}, headers: headers
p JSON.parse(result)
GET /signature-providers
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response. min: 1 , max: 100 , default: 10 |
skip | query | number | false | Number of items skipped during the selection. min: 0 , default: 0 |
order | query | string | false | Signature provider collection order |
filter[searchText] | query | string | false | Search by signature provider name |
filter[companyId] | query | UUID_V4 | false | Search by signature provider 'companyId' field |
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",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"themeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"provider": ""
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | signatureProviderFindResponse |
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 signature provider by {{id}}
Code samples
GET https://api.checkhub.io/signature-providers/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/signature-providers/{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/signature-providers/{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/signature-providers/{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/signature-providers/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /signature-providers/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"themeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"provider": ""
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | signatureProviderFindByIdResponse |
Signature Request
Get signature request collection
Code samples
GET https://api.checkhub.io/signature-requests HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/signature-requests',
{
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/signature-requests',
{
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/signature-requests', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/signature-requests',
params: {
}, headers: headers
p JSON.parse(result)
GET /signature-requests
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response. min: 1 , max: 100 , default: 10 |
skip | query | number | false | Number of items skipped during the selection. min: 0 , default: 0 |
order | query | string | false | Signature request collection order |
filter[search] | query | string | false | Search by signature request search |
filter[statuses][] | query | signatureRequestStatus | false | Filter result by statuses (or) |
filter[signerId] | query | UUID_V4 | false | Search by signature request 'signerId' field |
filter[signatureId] | query | UUID_V4 | false | Search by signature request 'signatureId' field |
filter[isSignedBySignerId] | query | boolean | false | Filter by signature request 'isSignedBySignerId' field |
includeCompany | query | boolean | false | To include company |
includeSignature | query | boolean | false | To include signature |
includeSigners | query | boolean | false | To include signers |
includeSignersEntity | query | boolean | false | To include signers entity |
includeSignersRole | query | boolean | false | To include signers role |
includeEntity | query | boolean | false | To include entity |
includeEntityAccount | query | boolean | false | To include entity account |
includeEntityCandidate | query | boolean | false | To include entity candidate |
includeEntityCandidateTags | query | boolean | false | To include entity candidate tags |
Enumerated Values
Parameter | Value |
---|---|
order | createdAt asc |
order | createdAt desc |
order | updatedAt asc |
order | updatedAt desc |
filter[statuses][] | open |
filter[statuses][] | pending |
filter[statuses][] | signed |
filter[statuses][] | canceled |
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",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"entity": "form",
"entityId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"externalSignatureRequestId": "",
"fileKey": "",
"signedFileKey": "",
"signedFileName": "",
"status": "open",
"isSerial": false,
"methods": [
"string"
],
"defaultMethod": "string",
"company": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it",
"pl",
"ro",
"sq",
"be",
"bg",
"hr",
"cs",
"da",
"et",
"fi",
"el",
"hu",
"is",
"ga",
"lv",
"lt",
"mk",
"mt",
"no",
"pt",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"uk",
"cy"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
},
"signature": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isSerial": false,
"methods": [
"string"
],
"defaultMethod": "string",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"providerId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"description": ""
},
"candidateForm": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Initial",
"folder": "Registration",
"actions": [
"complete",
"download"
],
"completedActions": [
"complete",
"download"
],
"isLocked": false,
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"isPdfGenerationEnabled": false,
"pdfFilePath": "pdf/file/path",
"pdfFileName": "string",
"remotePdfFilePath": "string",
"status": "requested",
"type": "editable",
"isAddition": false,
"parentId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"metadata": {},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"candidateResource": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Manager's contract",
"locked": false,
"text": "<p>It's the contract.</p>",
"completedActions": [
"complete",
"download"
],
"file": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"filename": "Contract J.J. Mask.pdf",
"remoteFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFilename": "Contract_example.pdf",
"fields": [
{
"reference": "Mask",
"value": {
"checkbox": false,
"text": "Mask",
"email": "Mask",
"signature": "data:image/png;base64,iVBORw0KGg"
}
}
],
"status": "requested",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies"
},
"candidateDocumentType": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"internal": false,
"folder": "string",
"customStatus": "pending",
"ocrParsedData": {},
"validationSnapshot": {
"total": 10,
"totalToBePending": 10,
"conditions": [
{
"type": "or",
"action": "score",
"score": 10,
"sequence": 1,
"isValid": true,
"validations": [
{
"rule": "string",
"method": "contains",
"value": {
"value": "value"
},
"fieldName": "firstName",
"fieldValue": "Field value",
"sequence": 1,
"isValid": true
}
]
}
]
},
"integrationTransferedAt": "string",
"mergeSetFilePath": "string",
"isMultiple": false,
"isProcessing": false,
"isPaused": false,
"combinedMultipleDocumentPath": "string",
"combinedMultipleDocumentName": "string",
"expiresOn": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false
},
"signers": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureRequestId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureRoleId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signerId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"externalSignerId": "",
"isSigned": true,
"sequence": 0,
"isNext": true,
"signedFileKey": "",
"sendSignedFile": true,
"token": "",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | signatureRequestFindResponse |
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 signature request by {{id}}
Code samples
GET https://api.checkhub.io/signature-requests/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/signature-requests/{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/signature-requests/{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/signature-requests/{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/signature-requests/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /signature-requests/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
includeCompany | query | boolean | false | To include company |
includeSignature | query | boolean | false | To include signature |
includeSigners | query | boolean | false | To include signers |
includeSignersEntity | query | boolean | false | To include signers entity |
includeSignersRole | query | boolean | false | To include signers role |
includeEntity | query | boolean | false | To include entity |
includeEntityAccount | query | boolean | false | To include entity account |
includeEntityCandidate | query | boolean | false | To include entity candidate |
includeEntityCandidateTags | query | boolean | false | To include entity candidate tags |
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",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"entity": "form",
"entityId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"externalSignatureRequestId": "",
"fileKey": "",
"signedFileKey": "",
"signedFileName": "",
"status": "open",
"isSerial": false,
"methods": [
"string"
],
"defaultMethod": "string",
"company": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it",
"pl",
"ro",
"sq",
"be",
"bg",
"hr",
"cs",
"da",
"et",
"fi",
"el",
"hu",
"is",
"ga",
"lv",
"lt",
"mk",
"mt",
"no",
"pt",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"uk",
"cy"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
},
"signature": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isSerial": false,
"methods": [
"string"
],
"defaultMethod": "string",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"providerId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"description": ""
},
"candidateForm": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Initial",
"folder": "Registration",
"actions": [
"complete",
"download"
],
"completedActions": [
"complete",
"download"
],
"isLocked": false,
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"isPdfGenerationEnabled": false,
"pdfFilePath": "pdf/file/path",
"pdfFileName": "string",
"remotePdfFilePath": "string",
"status": "requested",
"type": "editable",
"isAddition": false,
"parentId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"metadata": {},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"candidateResource": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Manager's contract",
"locked": false,
"text": "<p>It's the contract.</p>",
"completedActions": [
"complete",
"download"
],
"file": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"filename": "Contract J.J. Mask.pdf",
"remoteFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFilename": "Contract_example.pdf",
"fields": [
{
"reference": "Mask",
"value": {
"checkbox": false,
"text": "Mask",
"email": "Mask",
"signature": "data:image/png;base64,iVBORw0KGg"
}
}
],
"status": "requested",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies"
},
"candidateDocumentType": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"internal": false,
"folder": "string",
"customStatus": "pending",
"ocrParsedData": {},
"validationSnapshot": {
"total": 10,
"totalToBePending": 10,
"conditions": [
{
"type": "or",
"action": "score",
"score": 10,
"sequence": 1,
"isValid": true,
"validations": [
{
"rule": "string",
"method": "contains",
"value": {
"value": "value"
},
"fieldName": "firstName",
"fieldValue": "Field value",
"sequence": 1,
"isValid": true
}
]
}
]
},
"integrationTransferedAt": "string",
"mergeSetFilePath": "string",
"isMultiple": false,
"isProcessing": false,
"isPaused": false,
"combinedMultipleDocumentPath": "string",
"combinedMultipleDocumentName": "string",
"expiresOn": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false
},
"signers": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureRequestId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureRoleId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signerId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"externalSignerId": "",
"isSigned": true,
"sequence": 0,
"isNext": true,
"signedFileKey": "",
"sendSignedFile": true,
"token": "",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | signatureRequestFindByIdResponse |
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 |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response. min: 1 , max: 100 , default: 10 |
skip | query | number | false | Number of items skipped during the selection. min: 0 , default: 0 |
order | query | string | false | Tags collection order |
filter[searchText] | query | string | false | Search by tag name |
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. |
Deleting 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 should 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 should 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 should 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
Accept: application/json
const headers = {
'Accept':'application/json',
'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 = {
'Accept':'application/json',
'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 = {
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
r = requests.get('https://api.checkhub.io/tags/count', 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/count',
params: {
}, headers: headers
p JSON.parse(result)
GET /tags/count
Example responses
200 Response
{
"total": 0
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | tagCount |
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 |
Template
Get template collection
Code samples
GET https://api.checkhub.io/templates HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/templates',
{
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/templates',
{
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/templates', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
result = RestClient.get 'https://api.checkhub.io/templates',
params: {
}, headers: headers
p JSON.parse(result)
GET /templates
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
limit | query | number | false | Maximum number of items in the response. min: 1 , max: 100 , default: 10 |
skip | query | number | false | Number of items skipped during the selection. min: 0 , default: 0 |
order | query | string | false | Template collection order |
filter[name] | query | string | false | Search by template 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": "ASAP",
"type": "email",
"email": {
"editor": "tinymce",
"subject": "Welcome to Tesla!",
"content": "<div>Welcome to Tesla! </div><div>Here is your link for adding documents: `{link}`</div>",
"design": {},
"css": ".welcome {\n font-size: 25px;\n}"
},
"sms": {
"content": "Welcome to Tesla!\n Here is your link for adding documents: ..."
}
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | templateArray |
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 template
Code samples
POST https://api.checkhub.io/templates HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"name": "ASAP",
"type": "email",
"email": {
"editor": "tinymce",
"subject": "Welcome to Tesla!",
"content": "<div>Welcome to Tesla! </div><div>Here is your link for adding documents: `{link}`</div>",
"design": {},
"css": ".welcome {\n font-size: 25px;\n}"
},
"sms": {
"content": "Welcome to Tesla!\n Here is your link for adding documents: ..."
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/templates',
{
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",
"type": "email",
"email": {
"editor": "tinymce",
"subject": "Welcome to Tesla!",
"content": "<div>Welcome to Tesla! </div><div>Here is your link for adding documents: `{link}`</div>",
"design": {},
"css": ".welcome {\n font-size: 25px;\n}"
},
"sms": {
"content": "Welcome to Tesla!\n Here is your link for adding documents: ..."
}
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/templates',
{
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/templates', 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/templates',
params: {
}, headers: headers
p JSON.parse(result)
POST /templates
Body parameter
{
"name": "ASAP",
"type": "email",
"email": {
"editor": "tinymce",
"subject": "Welcome to Tesla!",
"content": "<div>Welcome to Tesla! </div><div>Here is your link for adding documents: `{link}`</div>",
"design": {},
"css": ".welcome {\n font-size: 25px;\n}"
},
"sms": {
"content": "Welcome to Tesla!\n Here is your link for adding documents: ..."
}
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
name | body | string | true | Template name |
type | body | string | false | Template type |
body | templateEmail | false | Template email | |
» editor | body | string | false | Email editor type (keep empty if you use API only) |
» subject | body | string | false | Email subject |
» content | body | string(html) | false | Email body. |
» design | body | object | false | The json configuration of the template content |
» css | body | string(css) | false | Styles that will be applied to the body of the email. |
sms | body | templateSms | false | Template SMS |
» content | body | string | false | The content of the sms message that the candidate will receive if certain conditions are met. |
Detailed descriptions
» content: The content of the sms message that the candidate will receive if certain conditions are met.
To validate content, please use the method: /validate-sms-content
{link}
to the candidate's profile at the end of the message will be added automatically.
Enumerated Values
Parameter | Value |
---|---|
type | email_sms |
type | |
type | sms |
» editor | tinymce |
» editor | unlayer |
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": "ASAP",
"type": "email",
"email": {
"editor": "tinymce",
"subject": "Welcome to Tesla!",
"content": "<div>Welcome to Tesla! </div><div>Here is your link for adding documents: `{link}`</div>",
"design": {},
"css": ".welcome {\n font-size: 25px;\n}"
},
"sms": {
"content": "Welcome to Tesla!\n Here is your link for adding documents: ..."
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | template |
Get template by {{id}}
Code samples
GET https://api.checkhub.io/templates/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/templates/{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/templates/{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/templates/{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/templates/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /templates/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be founded |
Example responses
200 Response
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "ASAP",
"type": "email",
"email": {
"editor": "tinymce",
"subject": "Welcome to Tesla!",
"content": "<div>Welcome to Tesla! </div><div>Here is your link for adding documents: `{link}`</div>",
"design": {},
"css": ".welcome {\n font-size: 25px;\n}"
},
"sms": {
"content": "Welcome to Tesla!\n Here is your link for adding documents: ..."
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | template |
Update template by {{id}}
Code samples
PATCH https://api.checkhub.io/templates/{id} HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"name": "ASAP",
"type": "email",
"email": {
"editor": "tinymce",
"subject": "Welcome to Tesla!",
"content": "<div>Welcome to Tesla! </div><div>Here is your link for adding documents: `{link}`</div>",
"design": {},
"css": ".welcome {\n font-size: 25px;\n}"
},
"sms": {
"content": "Welcome to Tesla!\n Here is your link for adding documents: ..."
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/templates/{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",
"type": "email",
"email": {
"editor": "tinymce",
"subject": "Welcome to Tesla!",
"content": "<div>Welcome to Tesla! </div><div>Here is your link for adding documents: `{link}`</div>",
"design": {},
"css": ".welcome {\n font-size: 25px;\n}"
},
"sms": {
"content": "Welcome to Tesla!\n Here is your link for adding documents: ..."
}
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/templates/{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/templates/{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/templates/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /templates/{id}
Body parameter
{
"name": "ASAP",
"type": "email",
"email": {
"editor": "tinymce",
"subject": "Welcome to Tesla!",
"content": "<div>Welcome to Tesla! </div><div>Here is your link for adding documents: `{link}`</div>",
"design": {},
"css": ".welcome {\n font-size: 25px;\n}"
},
"sms": {
"content": "Welcome to Tesla!\n Here is your link for adding documents: ..."
}
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be updated |
name | body | string | false | Template name |
type | body | string | false | Template type |
body | templateEmail | false | Template email | |
» editor | body | string | false | Email editor type (keep empty if you use API only) |
» subject | body | string | false | Email subject |
» content | body | string(html) | false | Email body. |
» design | body | object | false | The json configuration of the template content |
» css | body | string(css) | false | Styles that will be applied to the body of the email. |
sms | body | templateSms | false | Template SMS |
» content | body | string | false | The content of the sms message that the candidate will receive if certain conditions are met. |
Detailed descriptions
» content: The content of the sms message that the candidate will receive if certain conditions are met.
To validate content, please use the method: /validate-sms-content
{link}
to the candidate's profile at the end of the message will be added automatically.
Enumerated Values
Parameter | Value |
---|---|
type | email_sms |
type | |
type | sms |
» editor | tinymce |
» editor | unlayer |
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": "ASAP",
"type": "email",
"email": {
"editor": "tinymce",
"subject": "Welcome to Tesla!",
"content": "<div>Welcome to Tesla! </div><div>Here is your link for adding documents: `{link}`</div>",
"design": {},
"css": ".welcome {\n font-size: 25px;\n}"
},
"sms": {
"content": "Welcome to Tesla!\n Here is your link for adding documents: ..."
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | template |
Delete template by {{id}}
Code samples
DELETE https://api.checkhub.io/templates/{id} HTTP/1.1
Host: api.checkhub.io
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/templates/{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/templates/{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/templates/{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/templates/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /templates/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | string | true | Model id which should be deleted |
Example responses
200 Response
{
"success": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | successfullyCompletedRequest |
Validate SMS content
Code samples
POST https://api.checkhub.io/templates/validate-sms-content HTTP/1.1
Host: api.checkhub.io
Content-Type: application/json
Accept: application/json
const inputBody = '{
"content": "Welcome to Tesla!\n Here is your link for adding documents: ..."
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/templates/validate-sms-content',
{
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 = {
"content": "Welcome to Tesla!\n Here is your link for adding documents: ..."
};
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'API_KEY'
};
fetch('https://api.checkhub.io/templates/validate-sms-content',
{
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/templates/validate-sms-content', 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/templates/validate-sms-content',
params: {
}, headers: headers
p JSON.parse(result)
POST /templates/validate-sms-content
Body parameter
{
"content": "Welcome to Tesla!\n Here is your link for adding documents: ..."
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
body | body | templateValidateSmsContent | false | none |
Example responses
200 Response
{
"partChars": 160,
"isValid": true,
"maxPartsAmount": 8,
"partsAmount": 7,
"charsLeft": 122,
"maxChars": 1224
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Request was successful | templateValidateSmsContentResponse |
Schemas
successfullyCompletedRequest
{
"success": true
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
success | boolean | true | none | none |
countOfModifiedObjects
{
"count": 1
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
count | number | true | none | none |
language
"en"
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | none |
Enumerated Values
Property | Value |
---|---|
anonymous | en |
anonymous | fr |
anonymous | nl |
anonymous | de |
anonymous | it |
anonymous | pl |
anonymous | ro |
anonymous | sq |
anonymous | be |
anonymous | bg |
anonymous | hr |
anonymous | cs |
anonymous | da |
anonymous | et |
anonymous | fi |
anonymous | el |
anonymous | hu |
anonymous | is |
anonymous | ga |
anonymous | lv |
anonymous | lt |
anonymous | mk |
anonymous | mt |
anonymous | no |
anonymous | pt |
anonymous | ru |
anonymous | sr |
anonymous | sk |
anonymous | sl |
anonymous | es |
anonymous | sv |
anonymous | uk |
anonymous | cy |
translations
{
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
en | string | false | none | none |
fr | string | false | none | none |
nl | string | false | none | none |
de | string | false | none | none |
it | string | false | none | none |
pl | string | false | none | none |
ro | string | false | none | none |
sq | string | false | none | none |
be | string | false | none | none |
bg | string | false | none | none |
hr | string | false | none | none |
cs | string | false | none | none |
da | string | false | none | none |
et | string | false | none | none |
fi | string | false | none | none |
el | string | false | none | none |
hu | string | false | none | none |
is | string | false | none | none |
ga | string | false | none | none |
lv | string | false | none | none |
lt | string | false | none | none |
mk | string | false | none | none |
mt | string | false | none | none |
no | string | false | none | none |
pt | string | false | none | none |
ru | string | false | none | none |
sr | string | false | none | none |
sk | string | false | none | none |
sl | string | false | none | none |
es | string | false | none | none |
sv | string | false | none | none |
uk | string | false | none | none |
cy | string | false | none | none |
UUID_V4
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
Unique identifier for the entity
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | Unique identifier for the entity |
DateISO
"2019-09-12T15:36:09.264Z"
Datetime in ISO format
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string(date-time) | false | none | Datetime in ISO format |
account
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"aboutText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedBoxText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | true | none | Unique identifier for the entity |
companyId | UUID_V4 | true | none | Unique identifier for the entity |
name | string | true | none | Account name |
reference | string | false | none | Account reference (unique identifier for the account) |
welcomeText | accountWelcomeText | false | none | Properties for account welcome text entity |
aboutText | accountAboutText | false | none | Properties for account about text entity |
completedBoxText | accountCompletedBoxText | false | none | Properties for account completed box text entity |
completedText | accountCompletedText | false | none | Properties for account completed text entity |
createdAt | DateISO | true | none | Datetime in ISO format |
updatedAt | DateISO | true | none | Datetime in ISO format |
accountCount
{
"count": 0
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
count | number | true | none | none |
accountStats
{
"totalCandidates": 9,
"totalArchived": 3,
"totalDocuments": 36
}
Account statistic
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
totalCandidates | number | false | none | The total number of candidates on the account |
totalArchived | number | false | none | Total number of archived candidates on the account |
totalDocuments | number | false | none | The total number of uploaded documents. |
accountArray
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"aboutText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedBoxText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
Array of accounts
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [account] | false | none | Array of accounts |
accountCreate
{
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"aboutText": {
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedBoxText": {
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedText": {
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
}
}
Create a new account
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
name | string | true | none | Account name |
reference | string | false | none | Account reference (unique identifier for the account) |
welcomeText | accountWelcomeTextBase | false | none | This scheme is a collection of account welcome text for users in different languages. |
aboutText | accountAboutTextBase | false | none | This scheme is a collection of account about text for users in different languages. |
completedBoxText | accountCompletedBoxTextBase | false | none | This scheme is a collection of account completed box text for users in different languages. |
completedText | accountCompletedTextBase | false | none | This scheme is a collection of account completed text for users in different languages. |
accountUpdate
{
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"aboutText": {
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedBoxText": {
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedText": {
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
}
}
Update existed account
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
name | string | false | none | Account name |
reference | string | false | none | Account reference (unique identifier for the account) |
welcomeText | accountWelcomeTextBase | false | none | This scheme is a collection of account welcome text for users in different languages. |
aboutText | accountAboutTextBase | false | none | This scheme is a collection of account about text for users in different languages. |
completedBoxText | accountCompletedBoxTextBase | false | none | This scheme is a collection of account completed box text for users in different languages. |
completedText | accountCompletedTextBase | false | none | This scheme is a collection of account completed text for users in different languages. |
accountWithStats
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"aboutText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedBoxText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"stats": {
"totalCandidates": 9,
"totalArchived": 3,
"totalDocuments": 36
}
}
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | account | false | none | none |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | object | false | none | none |
» stats | accountStats | false | none | Account statistic |
accountWithStatsArray
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"aboutText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedBoxText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"stats": {
"totalCandidates": 9,
"totalArchived": 3,
"totalDocuments": 36
}
}
]
Array of accounts with statistics
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [accountWithStats] | false | none | Array of accounts with statistics |
accountFindByIdResponse
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"aboutText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedBoxText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidates": [
{
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
}
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | account | false | none | none |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | accountRelations | false | none | Scenario included relations |
accountFindResponse
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"aboutText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedBoxText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidates": [
{
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
}
]
Account collection
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | account | false | none | none |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | accountRelations | false | none | Scenario included relations |
accountRelations
{
"candidates": [
{
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
}
Scenario included relations
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
candidates | candidateArray | false | none | Related candidates |
accountWelcomeText
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
}
Properties for account welcome text entity
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | object | false | none | Immutable account welcome text properties |
» id | UUID_V4 | true | none | Unique identifier for the entity |
» accountId | UUID_V4 | true | none | Unique identifier for the entity |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | accountWelcomeTextBase | false | none | This scheme is a collection of account welcome text for users in different languages. |
accountWelcomeTextBase
{
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
}
This scheme is a collection of account welcome text for users in different languages.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
en | string(html) | false | none | Used for users whose language is "English" |
fr | string(html) | false | none | Used for users whose language is "Français" |
nl | string(html) | false | none | Used for users whose language is "Nederlands" |
de | string(html) | false | none | Used for users whose language is "Deutsch" |
it | string(html) | false | none | Used for users whose language is "Italiano" |
pl | string(html) | false | none | Used for users whose language is "Polski" |
ro | string(html) | false | none | Used for users whose language is "Română" |
sq | string(html) | false | none | Used for users whose language is "Shqip" |
be | string(html) | false | none | Used for users whose language is "Беларуская" |
bg | string(html) | false | none | Used for users whose language is "Български" |
hr | string(html) | false | none | Used for users whose language is "Hrvatski" |
cs | string(html) | false | none | Used for users whose language is "Čeština" |
da | string(html) | false | none | Used for users whose language is "Dansk" |
et | string(html) | false | none | Used for users whose language is "Eesti" |
fi | string(html) | false | none | Used for users whose language is "Suomi" |
el | string(html) | false | none | Used for users whose language is "Ελληνικά" |
hu | string(html) | false | none | Used for users whose language is "Magyar" |
is | string(html) | false | none | Used for users whose language is "Íslenska" |
ga | string(html) | false | none | Used for users whose language is "Gaeilge" |
lv | string(html) | false | none | Used for users whose language is "Latviešu" |
lt | string(html) | false | none | Used for users whose language is "Lietuvių" |
mk | string(html) | false | none | Used for users whose language is "Македонски" |
mt | string(html) | false | none | Used for users whose language is "Malti" |
no | string(html) | false | none | Used for users whose language is "Norsk" |
pt | string(html) | false | none | Used for users whose language is "Português" |
ru | string(html) | false | none | Used for users whose language is "Русский" |
sr | string(html) | false | none | Used for users whose language is "Српски" |
sk | string(html) | false | none | Used for users whose language is "Slovenčina" |
sl | string(html) | false | none | Used for users whose language is "Slovenščina" |
es | string(html) | false | none | Used for users whose language is "Español" |
sv | string(html) | false | none | Used for users whose language is "Svenska" |
uk | string(html) | false | none | Used for users whose language is "Українська" |
cy | string(html) | false | none | Used for users whose language is "Cymraeg" |
accountAboutText
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
}
Properties for account about text entity
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | object | false | none | Immutable account about text properties |
» id | UUID_V4 | true | none | Unique identifier for the entity |
» accountId | UUID_V4 | true | none | Unique identifier for the entity |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | accountAboutTextBase | false | none | This scheme is a collection of account about text for users in different languages. |
accountAboutTextBase
{
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
}
This scheme is a collection of account about text for users in different languages.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
en | string(html) | false | none | Used for users whose language is "English" |
fr | string(html) | false | none | Used for users whose language is "Français" |
nl | string(html) | false | none | Used for users whose language is "Nederlands" |
de | string(html) | false | none | Used for users whose language is "Deutsch" |
it | string(html) | false | none | Used for users whose language is "Italiano" |
pl | string(html) | false | none | Used for users whose language is "Polski" |
ro | string(html) | false | none | Used for users whose language is "Română" |
sq | string(html) | false | none | Used for users whose language is "Shqip" |
be | string(html) | false | none | Used for users whose language is "Беларуская" |
bg | string(html) | false | none | Used for users whose language is "Български" |
hr | string(html) | false | none | Used for users whose language is "Hrvatski" |
cs | string(html) | false | none | Used for users whose language is "Čeština" |
da | string(html) | false | none | Used for users whose language is "Dansk" |
et | string(html) | false | none | Used for users whose language is "Eesti" |
fi | string(html) | false | none | Used for users whose language is "Suomi" |
el | string(html) | false | none | Used for users whose language is "Ελληνικά" |
hu | string(html) | false | none | Used for users whose language is "Magyar" |
is | string(html) | false | none | Used for users whose language is "Íslenska" |
ga | string(html) | false | none | Used for users whose language is "Gaeilge" |
lv | string(html) | false | none | Used for users whose language is "Latviešu" |
lt | string(html) | false | none | Used for users whose language is "Lietuvių" |
mk | string(html) | false | none | Used for users whose language is "Македонски" |
mt | string(html) | false | none | Used for users whose language is "Malti" |
no | string(html) | false | none | Used for users whose language is "Norsk" |
pt | string(html) | false | none | Used for users whose language is "Português" |
ru | string(html) | false | none | Used for users whose language is "Русский" |
sr | string(html) | false | none | Used for users whose language is "Српски" |
sk | string(html) | false | none | Used for users whose language is "Slovenčina" |
sl | string(html) | false | none | Used for users whose language is "Slovenščina" |
es | string(html) | false | none | Used for users whose language is "Español" |
sv | string(html) | false | none | Used for users whose language is "Svenska" |
uk | string(html) | false | none | Used for users whose language is "Українська" |
cy | string(html) | false | none | Used for users whose language is "Cymraeg" |
accountCompletedText
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
}
Properties for account completed text entity
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | object | false | none | Immutable account completed text properties |
» id | UUID_V4 | true | none | Unique identifier for the entity |
» accountId | UUID_V4 | true | none | Unique identifier for the entity |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | accountCompletedTextBase | false | none | This scheme is a collection of account completed text for users in different languages. |
accountCompletedTextBase
{
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
}
This scheme is a collection of account completed text for users in different languages.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
en | string(html) | false | none | Used for users whose language is "English" |
fr | string(html) | false | none | Used for users whose language is "Français" |
nl | string(html) | false | none | Used for users whose language is "Nederlands" |
de | string(html) | false | none | Used for users whose language is "Deutsch" |
it | string(html) | false | none | Used for users whose language is "Italiano" |
pl | string(html) | false | none | Used for users whose language is "Polski" |
ro | string(html) | false | none | Used for users whose language is "Română" |
sq | string(html) | false | none | Used for users whose language is "Shqip" |
be | string(html) | false | none | Used for users whose language is "Беларуская" |
bg | string(html) | false | none | Used for users whose language is "Български" |
hr | string(html) | false | none | Used for users whose language is "Hrvatski" |
cs | string(html) | false | none | Used for users whose language is "Čeština" |
da | string(html) | false | none | Used for users whose language is "Dansk" |
et | string(html) | false | none | Used for users whose language is "Eesti" |
fi | string(html) | false | none | Used for users whose language is "Suomi" |
el | string(html) | false | none | Used for users whose language is "Ελληνικά" |
hu | string(html) | false | none | Used for users whose language is "Magyar" |
is | string(html) | false | none | Used for users whose language is "Íslenska" |
ga | string(html) | false | none | Used for users whose language is "Gaeilge" |
lv | string(html) | false | none | Used for users whose language is "Latviešu" |
lt | string(html) | false | none | Used for users whose language is "Lietuvių" |
mk | string(html) | false | none | Used for users whose language is "Македонски" |
mt | string(html) | false | none | Used for users whose language is "Malti" |
no | string(html) | false | none | Used for users whose language is "Norsk" |
pt | string(html) | false | none | Used for users whose language is "Português" |
ru | string(html) | false | none | Used for users whose language is "Русский" |
sr | string(html) | false | none | Used for users whose language is "Српски" |
sk | string(html) | false | none | Used for users whose language is "Slovenčina" |
sl | string(html) | false | none | Used for users whose language is "Slovenščina" |
es | string(html) | false | none | Used for users whose language is "Español" |
sv | string(html) | false | none | Used for users whose language is "Svenska" |
uk | string(html) | false | none | Used for users whose language is "Українська" |
cy | string(html) | false | none | Used for users whose language is "Cymraeg" |
accountCompletedBoxText
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
}
Properties for account completed box text entity
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | object | false | none | Immutable account completed box text properties |
» id | UUID_V4 | true | none | Unique identifier for the entity |
» accountId | UUID_V4 | true | none | Unique identifier for the entity |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | accountCompletedBoxTextBase | false | none | This scheme is a collection of account completed box text for users in different languages. |
accountCompletedBoxTextBase
{
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
}
This scheme is a collection of account completed box text for users in different languages.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
en | string(html) | false | none | Used for users whose language is "English" |
fr | string(html) | false | none | Used for users whose language is "Français" |
nl | string(html) | false | none | Used for users whose language is "Nederlands" |
de | string(html) | false | none | Used for users whose language is "Deutsch" |
it | string(html) | false | none | Used for users whose language is "Italiano" |
pl | string(html) | false | none | Used for users whose language is "Polski" |
ro | string(html) | false | none | Used for users whose language is "Română" |
sq | string(html) | false | none | Used for users whose language is "Shqip" |
be | string(html) | false | none | Used for users whose language is "Беларуская" |
bg | string(html) | false | none | Used for users whose language is "Български" |
hr | string(html) | false | none | Used for users whose language is "Hrvatski" |
cs | string(html) | false | none | Used for users whose language is "Čeština" |
da | string(html) | false | none | Used for users whose language is "Dansk" |
et | string(html) | false | none | Used for users whose language is "Eesti" |
fi | string(html) | false | none | Used for users whose language is "Suomi" |
el | string(html) | false | none | Used for users whose language is "Ελληνικά" |
hu | string(html) | false | none | Used for users whose language is "Magyar" |
is | string(html) | false | none | Used for users whose language is "Íslenska" |
ga | string(html) | false | none | Used for users whose language is "Gaeilge" |
lv | string(html) | false | none | Used for users whose language is "Latviešu" |
lt | string(html) | false | none | Used for users whose language is "Lietuvių" |
mk | string(html) | false | none | Used for users whose language is "Македонски" |
mt | string(html) | false | none | Used for users whose language is "Malti" |
no | string(html) | false | none | Used for users whose language is "Norsk" |
pt | string(html) | false | none | Used for users whose language is "Português" |
ru | string(html) | false | none | Used for users whose language is "Русский" |
sr | string(html) | false | none | Used for users whose language is "Српски" |
sk | string(html) | false | none | Used for users whose language is "Slovenčina" |
sl | string(html) | false | none | Used for users whose language is "Slovenščina" |
es | string(html) | false | none | Used for users whose language is "Español" |
sv | string(html) | false | none | Used for users whose language is "Svenska" |
uk | string(html) | false | none | Used for users whose language is "Українська" |
cy | string(html) | false | none | Used for users whose language is "Cymraeg" |
accessToken
{
"id": "TDzlHHx590XulC7KygP4MIo6BQGg2QKMO3UvEvwEtNssGISZ43FrRUmt2XzbxkOY",
"ttl": 43200,
"created": "2019-09-12T15:36:09.264Z",
"userId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Token to access the API
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | string | false | none | Authentication token. |
ttl | number | false | none | How long the token will be valid from the moment of its creation (in seconds) |
created | DateISO | false | none | Datetime in ISO format |
userId | UUID_V4 | false | none | Unique identifier for the entity |
adminUser
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"lastActivityAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"isOwner": false
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | true | none | Unique identifier for the entity |
companyId | UUID_V4 | true | none | Unique identifier for the entity |
companyTokenId | UUID_V4 | false | none | Only for users who impersonate API keys. |
createdAt | DateISO | false | none | Datetime in ISO format |
lastActivityAt | DateISO | false | none | Datetime in ISO format |
updatedAt | DateISO | false | none | Datetime in ISO format |
gender | adminUserGender | false | none | Admin User Gender |
firstName | string | true | none | Admin User First Name |
lastName | string | true | none | Admin User Last Name |
string | true | none | Admin User Email address | |
phone | string | false | none | Admin User Phone |
position | string | false | none | Admin User Position |
language | adminUserLanguage | true | none | Admin User language |
forceChangePassword | boolean | false | none | Enable password force change |
isOwner | boolean | false | none | Is owner of company |
adminUserRelations
{
"company": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it",
"pl",
"ro",
"sq",
"be",
"bg",
"hr",
"cs",
"da",
"et",
"fi",
"el",
"hu",
"is",
"ga",
"lv",
"lt",
"mk",
"mt",
"no",
"pt",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"uk",
"cy"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
},
"viewSettings": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateVisibleColumns": [
"default_status",
"default_candidate"
],
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"signature": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"type": "upload",
"originalId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"blackId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"whiteId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
}
Admin user included relations
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
company | company | false | none | Related Company |
viewSettings | adminUserView | false | none | View Settings |
signature | adminUserSignature | false | none | Signature |
adminUserArray
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"lastActivityAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"isOwner": false
}
]
Array of admin users
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [adminUser] | false | none | Array of admin users |
adminUserLanguage
"en"
Admin User language
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | Admin User language |
Enumerated Values
Property | Value |
---|---|
anonymous | en |
anonymous | fr |
anonymous | nl |
anonymous | de |
anonymous | it |
anonymous | pl |
anonymous | ro |
anonymous | sq |
anonymous | be |
anonymous | bg |
anonymous | hr |
anonymous | cs |
anonymous | da |
anonymous | et |
anonymous | fi |
anonymous | el |
anonymous | hu |
anonymous | is |
anonymous | ga |
anonymous | lv |
anonymous | lt |
anonymous | mk |
anonymous | mt |
anonymous | no |
anonymous | pt |
anonymous | ru |
anonymous | sr |
anonymous | sk |
anonymous | sl |
anonymous | es |
anonymous | sv |
anonymous | uk |
anonymous | cy |
adminUserGender
"female"
Admin User Gender
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | Admin User Gender |
Enumerated Values
Property | Value |
---|---|
anonymous | |
anonymous | male |
anonymous | female |
adminUserCreate
{
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"isOwner": false,
"password": "6kgiWMzhKD0IPzRS"
}
Create Admin User body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
gender | adminUserGender | false | none | Admin User Gender |
firstName | string | true | none | Admin User First Name |
lastName | string | true | none | Admin User Last Name |
string | true | none | Admin User Email address | |
phone | string | false | none | Admin User Phone |
position | string | false | none | Admin User Position |
language | adminUserLanguage | false | none | Admin User language |
forceChangePassword | boolean | false | none | Enable password force change |
isOwner | boolean | false | none | Is owner of company |
password | string | true | none | Admin User Password |
adminUserUpdate
{
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"isOwner": false,
"newPassword": "6kgiWMzhKD0IPzRS"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
gender | adminUserGender | false | none | Admin User Gender |
firstName | string | false | none | Admin User First Name |
lastName | string | false | none | Admin User Last Name |
string | false | none | Admin User Email address | |
phone | string | false | none | Admin User Phone |
position | string | false | none | Admin User Position |
language | adminUserLanguage | false | none | Admin User language |
forceChangePassword | boolean | false | none | Enable password force change |
isOwner | boolean | false | none | Is owner of company |
newPassword | string | false | none | New password for the user |
adminUserLogin
{
"email": "[email protected]",
"password": "eTmESlA3000"
}
Login data
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
string | false | none | Admin user email | |
password | string | false | none | Admin user password |
adminUserChangePassword
{
"password": "1xzoJz1mGIMplacy",
"newPassword": "MxUVl7a3iPyuWR4s",
"confirmPassword": "MxUVl7a3iPyuWR4s"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
password | string | false | none | Current password |
newPassword | string | false | none | New password |
confirmPassword | string | false | none | Confirm new password |
adminUserChangePasswordResponse
{
"isPasswordChanged": true
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
isPasswordChanged | boolean | false | none | Whether the user's password has been changed. |
adminUserCheckEmail
{
"email": "[email protected]",
"ownId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
string | true | none | Email to check | |
ownId | UUID_V4 | false | none | If this is an existing user excludes him from the search. |
adminUserCheckEmailResponse
{
"isUnique": true
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
isUnique | boolean | false | none | Is it email address unique |
adminUserFindResponse
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"lastActivityAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"isOwner": false,
"company": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it",
"pl",
"ro",
"sq",
"be",
"bg",
"hr",
"cs",
"da",
"et",
"fi",
"el",
"hu",
"is",
"ga",
"lv",
"lt",
"mk",
"mt",
"no",
"pt",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"uk",
"cy"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
},
"viewSettings": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateVisibleColumns": [
"default_status",
"default_candidate"
],
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"signature": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"type": "upload",
"originalId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"blackId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"whiteId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
}
]
Admin user collection
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | adminUser | false | none | none |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | adminUserRelations | false | none | Admin user included relations |
adminUserFindByIdResponse
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"lastActivityAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"isOwner": false,
"company": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it",
"pl",
"ro",
"sq",
"be",
"bg",
"hr",
"cs",
"da",
"et",
"fi",
"el",
"hu",
"is",
"ga",
"lv",
"lt",
"mk",
"mt",
"no",
"pt",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"uk",
"cy"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
},
"viewSettings": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateVisibleColumns": [
"default_status",
"default_candidate"
],
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"signature": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"type": "upload",
"originalId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"blackId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"whiteId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
}
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | adminUser | false | none | none |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | adminUserRelations | false | none | Admin user included relations |
adminUserGetInfoResponse
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"lastActivityAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"isOwner": false,
"elevioUserHash": "828caxxxxxxx4cdde",
"elevioGroups": [],
"elevioTraits": [],
"acl": {
"conditions": [
{
"acl": {
"accountIds": [
"string"
],
"isAllAccounts": true,
"onlyRelatedCandidates": true,
"availableTagIds": [
"string"
],
"isAllAvailableTags": true,
"restrictedTagIds": [
"string"
],
"restrictedTagsCondition": "or",
"isAllRestrictedTags": true,
"rights": [
"candidateCreate",
"candidateView"
]
}
}
],
"rights": [
"candidateCreate",
"candidateView"
]
},
"company": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it",
"pl",
"ro",
"sq",
"be",
"bg",
"hr",
"cs",
"da",
"et",
"fi",
"el",
"hu",
"is",
"ga",
"lv",
"lt",
"mk",
"mt",
"no",
"pt",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"uk",
"cy"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
},
"viewSettings": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateVisibleColumns": [
"default_status",
"default_candidate"
],
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"signature": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"type": "upload",
"originalId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"blackId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"whiteId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
}
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | adminUser | false | none | none |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | adminUserInjections | false | none | Admin user additional properties |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | adminUserRelations | false | none | Admin user included relations |
adminUserInjections
{
"elevioUserHash": "828caxxxxxxx4cdde",
"elevioGroups": [],
"elevioTraits": [],
"acl": {
"conditions": [
{
"acl": {
"accountIds": [
"string"
],
"isAllAccounts": true,
"onlyRelatedCandidates": true,
"availableTagIds": [
"string"
],
"isAllAvailableTags": true,
"restrictedTagIds": [
"string"
],
"restrictedTagsCondition": "or",
"isAllRestrictedTags": true,
"rights": [
"candidateCreate",
"candidateView"
]
}
}
],
"rights": [
"candidateCreate",
"candidateView"
]
}
}
Admin user additional properties
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
elevioUserHash | string | false | none | Admin user hash for access to the elevio |
elevioGroups | [string] | false | none | Admin user group in elevio |
elevioTraits | [string] | false | none | Distinctive features of the user. |
acl | object | false | none | Admin user acl settings |
» conditions | [object] | false | none | Acl condition |
»» acl | object | false | none | Admin user acl settings |
»»» accountIds | [string] | false | none | Condition account ids |
»»» isAllAccounts | boolean | false | none | Admin users in this group will have the assigned rights for all company accounts. |
»»» onlyRelatedCandidates | boolean | false | none | Admin users in this group will have the assigned rights for candidates they have created or candidates that have been assigned to them. |
»»» availableTagIds | [string] | false | none | Condition group available tag ids |
»»» isAllAvailableTags | boolean | false | none | It shows that all tags are available for this condition |
»»» restrictedTagIds | [string] | false | none | Condition group restricted tag ids |
»»» restrictedTagsCondition | adminUserGroupRestrictedTagsCondition | false | none | none |
»»» isAllRestrictedTags | boolean | false | none | if it is true then there is not any restriction for access. Usually it is false if there is at least one tag in the availableTagIds |
»»» rights | [string] | false | none | Condition right names |
» rights | [string] | false | none | Admin user right names |
adminUserSignature
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"type": "upload",
"originalId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"blackId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"whiteId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | false | none | Unique identifier for the entity |
companyId | UUID_V4 | false | none | Unique identifier for the entity |
adminUserId | UUID_V4 | false | none | Unique identifier for the entity |
createdAt | DateISO | false | none | Datetime in ISO format |
updatedAt | DateISO | false | none | Datetime in ISO format |
type | string | false | none | Signature type |
originalId | UUID_V4 | false | none | Unique identifier for the entity |
blackId | UUID_V4 | false | none | Unique identifier for the entity |
whiteId | UUID_V4 | false | none | Unique identifier for the entity |
Enumerated Values
Property | Value |
---|---|
type | draw |
type | upload |
adminUserSignatureArray
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"type": "upload",
"originalId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"blackId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"whiteId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
Array of admin user signatures
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [adminUserSignature] | false | none | Array of admin user signatures |
adminUserSignatureCreate
{
"type": "upload",
"originalId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"blackId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"whiteId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Create Selfie body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
type | string | false | none | Signature type |
originalId | UUID_V4 | false | none | Unique identifier for the entity |
blackId | UUID_V4 | false | none | Unique identifier for the entity |
whiteId | UUID_V4 | false | none | Unique identifier for the entity |
Enumerated Values
Property | Value |
---|---|
type | draw |
type | upload |
adminUserSignatureUpdate
{
"type": "upload",
"originalId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"blackId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"whiteId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Update Admin User Signature body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
type | string | false | none | Signature type |
originalId | UUID_V4 | false | none | Unique identifier for the entity |
blackId | UUID_V4 | false | none | Unique identifier for the entity |
whiteId | UUID_V4 | false | none | Unique identifier for the entity |
Enumerated Values
Property | Value |
---|---|
type | draw |
type | upload |
adminUserSignatureFindResponse
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"type": "upload",
"originalId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"blackId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"whiteId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"original": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
},
"black": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
},
"white": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
}
}
]
Admin user signature collection
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | adminUserSignature | false | none | none |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | adminUserSignatureRelations | false | none | Admin user signature included relations |
adminUserSignatureFindByIdResponse
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"type": "upload",
"originalId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"blackId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"whiteId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"original": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
},
"black": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
},
"white": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
}
}
Admin user signature with relations
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | adminUserSignature | false | none | none |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | adminUserSignatureRelations | false | none | Admin user signature included relations |
adminUserSignatureRelations
{
"original": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
},
"black": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
},
"white": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
}
}
Admin user signature included relations
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
original | file | false | none | Related original file |
black | file | false | none | Related black file |
white | file | false | none | Related white file |
adminUserGroup
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isMain": false,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "First-line managers",
"reference": "First-line managers",
"adminUsers": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"adminUserRights": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllAccounts": false,
"restrictedTagsCondition": "or",
"onlyRelatedCandidates": true
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | false | none | Unique identifier for the entity |
companyId | UUID_V4 | false | none | Unique identifier for the entity |
isMain | boolean | false | none | If it is enabled the group includes all accounts, all access rights and at least one admin user |
createdAt | DateISO | false | none | Datetime in ISO format |
updatedAt | DateISO | false | none | Datetime in ISO format |
name | string | false | none | Admin user group name |
reference | string | false | none | Admin user group reference |
adminUsers | adminUserGroupAdminUsers | false | none | Array of admin users ids related to this group |
adminUserRights | adminUserGroupAdminUserRights | false | none | Array of admin user rights related to this group |
accounts | adminUserGroupAccounts | false | none | Array of accounts for which admin users have access and the specified rights apply. |
isAllAccounts | boolean | false | none | Admin users in this group will have the assigned rights for all company accounts. |
restrictedTagsCondition | adminUserGroupRestrictedTagsCondition | false | none | none |
onlyRelatedCandidates | boolean | false | none | Admin users in this group will have the assigned rights for candidates they have created or candidates that have been assigned to them. |
adminUserGroupArray
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isMain": false,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "First-line managers",
"reference": "First-line managers",
"adminUsers": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"adminUserRights": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllAccounts": false,
"restrictedTagsCondition": "or",
"onlyRelatedCandidates": true
}
]
Array of admin user groups
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [adminUserGroup] | false | none | Array of admin user groups |
adminUserGroupCreate
{
"name": "First-line managers",
"reference": "First-line managers",
"adminUsers": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"adminUserRights": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllAccounts": false,
"restrictedTagsCondition": "or",
"onlyRelatedCandidates": true,
"availableTags": [],
"restrictedTags": []
}
Create Admin User Group body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
name | string | true | none | Admin user group name |
reference | string | false | none | Admin user group reference |
adminUsers | adminUserGroupAdminUsers | false | none | Array of admin users ids related to this group |
adminUserRights | adminUserGroupAdminUserRights | true | none | Array of admin user rights related to this group. Should include min 1 item |
accounts | adminUserGroupAccounts | false | none | Array of account ids |
isAllAccounts | boolean | false | none | Admin users in this group will have the assigned rights for all company accounts. |
restrictedTagsCondition | adminUserGroupRestrictedTagsCondition | false | none | none |
onlyRelatedCandidates | boolean | false | none | Admin users in this group will have the assigned rights for candidates they have created or candidates that have been assigned to them. |
availableTags | [UUID_V4] | false | none | Array of tag ids |
restrictedTags | [UUID_V4] | false | none | Array of tag ids |
adminUserGroupUpdate
{
"name": "First-line managers",
"reference": "First-line managers",
"adminUsers": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"adminUserRights": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllAccounts": false,
"restrictedTagsCondition": "or",
"onlyRelatedCandidates": true,
"availableTags": [],
"restrictedTags": []
}
Update Admin User Group body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
name | string | false | none | Admin user group name |
reference | string | false | none | Admin user group reference |
adminUsers | adminUserGroupAdminUsers | false | none | Array of admin users ids related to this group |
adminUserRights | adminUserGroupAdminUserRights | false | none | Array of admin user rights related to this group |
accounts | adminUserGroupAccounts | false | none | Array of accounts for which admin users have access and the specified rights apply. |
isAllAccounts | boolean | false | none | Admin users in this group will have the assigned rights for all company accounts. |
restrictedTagsCondition | adminUserGroupRestrictedTagsCondition | false | none | none |
onlyRelatedCandidates | boolean | false | none | Admin users in this group will have the assigned rights for candidates they have created or candidates that have been assigned to them. |
availableTags | [UUID_V4] | false | none | Array of tag ids |
restrictedTags | [UUID_V4] | false | none | Array of tag ids |
adminUserGroupFindResponse
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isMain": false,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "First-line managers",
"reference": "First-line managers",
"adminUsers": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"adminUserRights": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllAccounts": false,
"restrictedTagsCondition": "or",
"onlyRelatedCandidates": true,
"availableTags": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
],
"restrictedTags": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
}
]
Admin user group collection
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | adminUserGroup | false | none | none |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | adminUserGroupRelations | false | none | Admin user group included relations |
adminUserGroupFindByIdResponse
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isMain": false,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "First-line managers",
"reference": "First-line managers",
"adminUsers": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"adminUserRights": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllAccounts": false,
"restrictedTagsCondition": "or",
"onlyRelatedCandidates": true,
"availableTags": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
],
"restrictedTags": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
}
Admin user group with relations
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | adminUserGroup | false | none | none |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | adminUserGroupRelations | false | none | Admin user group included relations |
adminUserGroupAccounts
[
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
Array of accounts for which admin users have access and the specified rights apply.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [UUID_V4] | false | none | Array of accounts for which admin users have access and the specified rights apply. |
adminUserGroupAdminUsers
[
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
Array of admin users ids related to this group
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [UUID_V4] | false | none | Array of admin users ids related to this group |
adminUserGroupAdminUserRights
[
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
Array of admin user rights related to this group
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [UUID_V4] | false | none | Array of admin user rights related to this group |
adminUserGroupRestrictedTagsCondition
"or"
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | none |
Enumerated Values
Property | Value |
---|---|
anonymous | or |
anonymous | and |
adminUserGroupRelations
{
"availableTags": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
],
"restrictedTags": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
}
Admin user group included relations
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
availableTags | adminUserGroupAvailableTagArray | false | none | Related available tags |
restrictedTags | adminUserGroupRestrictedTagArray | false | none | Related restricted tags |
adminUserRight
{
"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"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | true | none | Unique identifier for the entity |
createdAt | DateISO | true | none | Datetime in ISO format |
updatedAt | DateISO | true | none | Datetime in ISO format |
name | string | true | none | Admin user right name |
label | string | true | none | Admin user right label |
adminUserRightArray
[
{
"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"
}
]
Array of admin user rights
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [adminUserRight] | false | none | Array of admin user rights |
adminUserRightCreate
{
"name": "notificationManagement",
"label": "Access to Notification Management"
}
Create Admin User Right body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
name | string | true | none | Admin user right name |
label | string | true | none | Admin user right label |
adminUserRightUpdate
{
"name": "notificationManagement",
"label": "Access to Notification Management"
}
Update Admin User Right body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
name | string | false | none | Admin user right name |
label | string | false | none | Admin user right label |
adminUserRightFindResponse
[
{
"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"
}
]
Admin user right collection
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [adminUserRight] | false | none | Admin user right collection |
adminUserRightFindByIdResponse
{
"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"
}
Properties
None
adminUserView
{
"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"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | false | none | Unique identifier for the entity |
adminUserId | UUID_V4 | false | none | Unique identifier for the entity |
candidateVisibleColumns | adminUserViewCandidateVisibleColumns | false | none | Candidate list settings, affect only the admin application UI. |
createdAt | DateISO | false | none | Datetime in ISO format |
updatedAt | DateISO | false | none | Datetime in ISO format |
adminUserViewCandidateVisibleColumns
[
"default_status",
"default_candidate"
]
Candidate list settings, affect only the admin application UI.
Properties
None
adminUserGroupAvailableTag
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Model for linking admin user group and tags.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | false | none | Unique identifier for the entity |
tagId | UUID_V4 | false | none | Unique identifier for the entity |
companyId | UUID_V4 | false | none | Unique identifier for the entity |
adminUserGroupId | UUID_V4 | false | none | Unique identifier for the entity |
createdAt | DateISO | false | none | Datetime in ISO format |
updatedAt | DateISO | false | none | Datetime in ISO format |
adminUserGroupAvailableTagArray
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
Array of admin user group available tags
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [adminUserGroupAvailableTag] | false | none | Array of admin user group available tags |
adminUserGroupRestrictedTag
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Model for linking admin user group and tags.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | false | none | Unique identifier for the entity |
tagId | UUID_V4 | false | none | Unique identifier for the entity |
companyId | UUID_V4 | false | none | Unique identifier for the entity |
adminUserGroupId | UUID_V4 | false | none | Unique identifier for the entity |
createdAt | DateISO | false | none | Datetime in ISO format |
updatedAt | DateISO | false | none | Datetime in ISO format |
adminUserGroupRestrictedTagArray
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"adminUserGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
Array of admin user group restricted tags
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [adminUserGroupRestrictedTag] | false | none | Array of admin user group restricted tags |
candidate
{
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Immutable candidate properties
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
accountId | UUID_V4 | true | none | Unique identifier for the entity |
string | true | none | Candidate Email address | |
firstName | string | true | none | User First Name |
lastName | string | true | none | User Last Name |
reference | string | false | none | Candidate reference |
language | language | true | none | Candidate Language |
welcomeText | string | false | none | Welcome text for the candidate. (only if type 'custom' is selected) |
welcomeTextType | string | false | none | Welcome text type |
assigneeId | UUID_V4 | false | none | Candidate assignee id |
id | UUID_V4 | true | none | Unique identifier for the entity |
companyId | UUID_V4 | true | none | Unique identifier for the entity |
additionalEmails | candidateAdditionalEmails | false | none | Candidate additional emails. Not more than 5 emails |
snoozed | boolean | false | none | Turns off future notifications (email and SMS) to this candidate |
mobilePhone | string | false | none | User mobile phone number in the internal format |
notes | string | false | none | Candidate additional notes |
deadline | DateISO | false | none | Candidate deadline date |
createdById | UUID_V4 | false | none | Unique identifier for the entity |
status | candidateStatus | true | none | none |
token | string | true | none | Candidate access token |
archived | boolean | false | none | Candidate is archived or not |
integrationChanged | boolean | false | none | It shows integration current state, If true then integration is already triggered |
clientIsMobile | boolean | false | none | It says that candidate has been detected as mobile client |
clientVersion | string | false | none | Candidate browser and operating system |
lastLoggedAt | DateISO | false | none | Date of last candidate logged at |
statusUpdateAt | DateISO | false | none | The last updated status date |
createdAt | DateISO | false | none | Datetime in ISO format |
updatedAt | DateISO | false | none | Datetime in ISO format |
Enumerated Values
Property | Value |
---|---|
welcomeTextType | default |
welcomeTextType | custom |
welcomeTextType | none |
candidateArray
[
{
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
Array of candidates
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [candidate] | false | none | Array of candidates |
candidateFindResponse
[
{
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"account": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"aboutText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedBoxText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"company": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it",
"pl",
"ro",
"sq",
"be",
"bg",
"hr",
"cs",
"da",
"et",
"fi",
"el",
"hu",
"is",
"ga",
"lv",
"lt",
"mk",
"mt",
"no",
"pt",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"uk",
"cy"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
},
"documentStatistic": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"docRequestedTotal": 7,
"docProvidedTotal": 6,
"docMandatoryRequestedTotal": 4,
"docMandatoryProvidedTotal": 4,
"docOptionalRequestedTotal": 3,
"docOptionalProvidedTotal": 2,
"resourceTotal": 5,
"resourceCompletedTotal": 2,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"conversation": null,
"customFields": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "1234-456-32"
}
],
"user": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"lastActivityAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"isOwner": false
},
"tags": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z"
}
],
"resources": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Manager's contract",
"locked": false,
"text": "<p>It's the contract.</p>",
"completedActions": [
"complete",
"download"
],
"file": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"filename": "Contract J.J. Mask.pdf",
"remoteFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFilename": "Contract_example.pdf",
"fields": [
{
"reference": "Mask",
"value": {
"checkbox": false,
"text": "Mask",
"email": "Mask",
"signature": "data:image/png;base64,iVBORw0KGg"
}
}
],
"status": "requested",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies"
}
],
"candidateDocumentTypes": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"internal": false,
"folder": "string",
"customStatus": "pending",
"ocrParsedData": {},
"validationSnapshot": {
"total": 10,
"totalToBePending": 10,
"conditions": [
{
"type": "or",
"action": "score",
"score": 10,
"sequence": 1,
"isValid": true,
"validations": [
{
"rule": "string",
"method": "contains",
"value": {
"value": "value"
},
"fieldName": "firstName",
"fieldValue": "Field value",
"sequence": 1,
"isValid": true
}
]
}
]
},
"integrationTransferedAt": "string",
"mergeSetFilePath": "string",
"isMultiple": false,
"isProcessing": false,
"isPaused": false,
"combinedMultipleDocumentPath": "string",
"combinedMultipleDocumentName": "string",
"expiresOn": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false
}
]
}
]
Candidate Collection
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
accountId | UUID_V4 | true | none | Unique identifier for the entity |
string | true | none | Candidate Email address | |
firstName | string | true | none | User First Name |
lastName | string | true | none | User Last Name |
reference | string | false | none | Candidate reference |
language | language | true | none | Candidate Language |
welcomeText | string | false | none | Welcome text for the candidate. (only if type 'custom' is selected) |
welcomeTextType | string | false | none | Welcome text type |
assigneeId | UUID_V4 | false | none | Candidate assignee id |
id | UUID_V4 | true | none | Unique identifier for the entity |
companyId | UUID_V4 | true | none | Unique identifier for the entity |
additionalEmails | candidateAdditionalEmails | false | none | Candidate additional emails. Not more than 5 emails |
snoozed | boolean | false | none | Turns off future notifications (email and SMS) to this candidate |
mobilePhone | string | false | none | User mobile phone number in the internal format |
notes | string | false | none | Candidate additional notes |
deadline | DateISO | false | none | Candidate deadline date |
createdById | UUID_V4 | false | none | Unique identifier for the entity |
status | candidateStatus | true | none | none |
token | string | true | none | Candidate access token |
archived | boolean | false | none | Candidate is archived or not |
integrationChanged | boolean | false | none | It shows integration current state, If true then integration is already triggered |
clientIsMobile | boolean | false | none | It says that candidate has been detected as mobile client |
clientVersion | string | false | none | Candidate browser and operating system |
lastLoggedAt | DateISO | false | none | Date of last candidate logged at |
statusUpdateAt | DateISO | false | none | The last updated status date |
createdAt | DateISO | false | none | Datetime in ISO format |
updatedAt | DateISO | false | none | Datetime in ISO format |
account | account | false | none | Candidate account relation |
company | company | false | none | Candidate company relation |
documentStatistic | candidateDocumentStat | false | none | Candidate documentStatistic relation |
conversation | any | false | none | Candidate conversation relation |
customFields | [candidateCustomField] | false | none | Candidate customFields relation |
user | adminUser | false | none | Candidate conversation relation |
tags | [candidateTag] | false | none | Candidate tags relation |
resources | [candidateResource] | false | none | Candidate resources relation |
candidateDocumentTypes | [candidateDocumentType] | false | none | Candidate document types relation |
Enumerated Values
Property | Value |
---|---|
welcomeTextType | default |
welcomeTextType | custom |
welcomeTextType | none |
candidateFindByIdResponse
{
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"account": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"aboutText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedBoxText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"company": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it",
"pl",
"ro",
"sq",
"be",
"bg",
"hr",
"cs",
"da",
"et",
"fi",
"el",
"hu",
"is",
"ga",
"lv",
"lt",
"mk",
"mt",
"no",
"pt",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"uk",
"cy"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
},
"documentStatistic": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"docRequestedTotal": 7,
"docProvidedTotal": 6,
"docMandatoryRequestedTotal": 4,
"docMandatoryProvidedTotal": 4,
"docOptionalRequestedTotal": 3,
"docOptionalProvidedTotal": 2,
"resourceTotal": 5,
"resourceCompletedTotal": 2,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"conversation": null,
"customFields": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "1234-456-32"
}
],
"user": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"lastActivityAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"isOwner": false
},
"tags": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z"
}
],
"resources": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Manager's contract",
"locked": false,
"text": "<p>It's the contract.</p>",
"completedActions": [
"complete",
"download"
],
"file": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"filename": "Contract J.J. Mask.pdf",
"remoteFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFilename": "Contract_example.pdf",
"fields": [
{
"reference": "Mask",
"value": {
"checkbox": false,
"text": "Mask",
"email": "Mask",
"signature": "data:image/png;base64,iVBORw0KGg"
}
}
],
"status": "requested",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies"
}
],
"candidateDocumentTypes": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"internal": false,
"folder": "string",
"customStatus": "pending",
"ocrParsedData": {},
"validationSnapshot": {
"total": 10,
"totalToBePending": 10,
"conditions": [
{
"type": "or",
"action": "score",
"score": 10,
"sequence": 1,
"isValid": true,
"validations": [
{
"rule": "string",
"method": "contains",
"value": {
"value": "value"
},
"fieldName": "firstName",
"fieldValue": "Field value",
"sequence": 1,
"isValid": true
}
]
}
]
},
"integrationTransferedAt": "string",
"mergeSetFilePath": "string",
"isMultiple": false,
"isProcessing": false,
"isPaused": false,
"combinedMultipleDocumentPath": "string",
"combinedMultipleDocumentName": "string",
"expiresOn": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false
}
]
}
Immutable candidate properties
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
accountId | UUID_V4 | true | none | Unique identifier for the entity |
string | true | none | Candidate Email address | |
firstName | string | true | none | User First Name |
lastName | string | true | none | User Last Name |
reference | string | false | none | Candidate reference |
language | language | true | none | Candidate Language |
welcomeText | string | false | none | Welcome text for the candidate. (only if type 'custom' is selected) |
welcomeTextType | string | false | none | Welcome text type |
assigneeId | UUID_V4 | false | none | Candidate assignee id |
id | UUID_V4 | true | none | Unique identifier for the entity |
companyId | UUID_V4 | true | none | Unique identifier for the entity |
additionalEmails | candidateAdditionalEmails | false | none | Candidate additional emails. Not more than 5 emails |
snoozed | boolean | false | none | Turns off future notifications (email and SMS) to this candidate |
mobilePhone | string | false | none | User mobile phone number in the internal format |
notes | string | false | none | Candidate additional notes |
deadline | DateISO | false | none | Candidate deadline date |
createdById | UUID_V4 | false | none | Unique identifier for the entity |
status | candidateStatus | true | none | none |
token | string | true | none | Candidate access token |
archived | boolean | false | none | Candidate is archived or not |
integrationChanged | boolean | false | none | It shows integration current state, If true then integration is already triggered |
clientIsMobile | boolean | false | none | It says that candidate has been detected as mobile client |
clientVersion | string | false | none | Candidate browser and operating system |
lastLoggedAt | DateISO | false | none | Date of last candidate logged at |
statusUpdateAt | DateISO | false | none | The last updated status date |
createdAt | DateISO | false | none | Datetime in ISO format |
updatedAt | DateISO | false | none | Datetime in ISO format |
account | account | false | none | Candidate account relation |
company | company | false | none | Candidate company relation |
documentStatistic | candidateDocumentStat | false | none | Candidate documentStatistic relation |
conversation | any | false | none | Candidate conversation relation |
customFields | [candidateCustomField] | false | none | Candidate customFields relation |
user | adminUser | false | none | Candidate conversation relation |
tags | [candidateTag] | false | none | Candidate tags relation |
resources | [candidateResource] | false | none | Candidate resources relation |
candidateDocumentTypes | [candidateDocumentType] | false | none | Candidate document types relation |
Enumerated Values
Property | Value |
---|---|
welcomeTextType | default |
welcomeTextType | custom |
welcomeTextType | none |
candidateAdditionalEmails
[
"[email protected]"
]
Candidate additional emails. Not more than 5 emails
Properties
None
candidateStatus
"pending"
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | none |
Enumerated Values
Property | Value |
---|---|
anonymous | open |
anonymous | pending |
anonymous | completed |
anonymous | rejected |
candidateDeleteResponse
{
"count": 3
}
Delete candidates response
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
count | number | true | none | The total number of deleted candidates |
candidateDeleteFilter
{
"ids": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}
Filter properties
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
ids | [UUID_V4] | false | none | Candidate ids |
candidateCreateCustomField
{
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "custom_value"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
customFieldId | UUID_V4 | false | none | Unique identifier for the entity |
value | string | false | none | Custom field value |
candidateCreateCustomFields
[
{
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "custom_value"
}
]
Custom fields that will be applied to the candidate during creation.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [candidateCreateCustomField] | false | none | Custom fields that will be applied to the candidate during creation. |
candidateCreateTags
[
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
Tags that will be applied to the candidate during creation.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [UUID_V4] | false | none | Tags that will be applied to the candidate during creation. |
candidateBulkCandidate
{
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"reference": "j_good1991",
"language": "en",
"deadline": "2019-09-12T15:36:09.264Z",
"additionalEmails": [
"[email protected]"
],
"mobilePhone": "+3801234567890",
"preset": "preset_1, preset_2",
"tags": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"presetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFields": [
{
"reference": "string",
"value": "string"
}
]
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
firstName | string | true | none | User First Name |
lastName | string | true | none | User Last Name |
string | true | none | Candidate Email address | |
reference | string | false | none | Candidate reference |
language | language | true | none | Candidate language |
deadline | DateISO | false | none | Candidate deadline date |
additionalEmails | candidateAdditionalEmails | false | none | Candidate additional emails. Not more than 5 emails |
mobilePhone | string | false | none | User mobile phone number in the international format |
preset | string | false | none | Presets references with ',' separator |
tags | candidateCreateTags | false | none | Tags that will be applied to the candidate during creation. |
presetId | UUID_V4 | false | none | Unique identifier for the entity |
assigneeId | UUID_V4 | false | none | Unique identifier for the entity |
customFields | [object] | false | none | Candidate custom fields |
» reference | string | true | none | Custom field reference |
» value | string | true | none | Custom field value |
candidateBulkDocument
{
"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"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
documentTypeId | UUID_V4 | true | none | Unique identifier for the entity |
name | string | false | none | Candidate Document Type name |
description | string | false | none | Candidate Document Type description |
filename | string | false | none | Candidate Document filename. It can include dynamic fields like {candidateFirstName} |
comment | string | false | none | Candidate Document Type comment |
commentType | candidateDocumentTypeCommentType | false | none | Candidate document type comment type |
mandatory | boolean | true | none | It says that Candidate Document Type is mandatory or optional for the candidate |
folder | string | false | none | Candidate Document Type files folder name |
candidateBulkForm
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": true,
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | true | none | Unique identifier for the entity |
actions | formActions | true | none | Candidate form actions |
isMandatory | boolean | false | none | It says that form is mandatory or optional for the candidate. |
signatureId | UUID_V4 | false | none | Signature id which you want to attach with the form. |
fileId | UUID_V4 | false | none | Custom file which added instead of original one (if exist) |
candidateBulkResource
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
]
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | true | none | Unique identifier for the entity |
actions | resourceActions | true | none | Candidate resource actions |
candidateBulkTags
{
"create": [
"string"
],
"apply": [
"string"
]
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
create | [string] | true | none | New tag names |
apply | [string] | true | none | Selected tag names |
candidateGetLastActivityResponse
{
"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"
}
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
object | false | none | none | |
» createdAt | DateISO | false | none | Datetime in ISO format |
» target | string | false | none | Email address |
» triggerType | string | false | none | Trigger type |
» templateName | string | false | none | Template name |
» scenarioName | string | false | none | Scenario name |
» scenarioEventName | string | false | none | Scenario name |
» deliveryStatus | string | false | none | Email delivery status |
sms | object | false | none | none |
» createdAt | DateISO | false | none | Datetime in ISO format |
» target | string | false | none | Phone number |
» triggerType | string | false | none | Trigger type |
» templateName | string | false | none | Template name |
» scenarioName | string | false | none | Scenario name |
» scenarioEventName | string | false | none | Scenario name |
candidateBulkResponse
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"reference": "b_candidate100"
}
]
Return empty array if it's not "immediately" mode
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | true | none | Unique identifier for the entity |
reference | string | false | none | Candidate reference |
candidateCommentsFilter
"unread"
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | none |
Enumerated Values
Property | Value |
---|---|
anonymous | all |
anonymous | unread |
candidateUpdateTags
[
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
Tags that will be applied to the candidate during update.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [UUID_V4] | false | none | Tags that will be applied to the candidate during update. |
candidateToken
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"tokenLink": "1BlgIvCY20NjUXlRj",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validToken": true
}
Candidate Token
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | object | false | none | none |
» id | UUID_V4 | true | none | Unique identifier for the entity |
» createdAt | DateISO | true | none | Datetime in ISO format |
» updatedAt | DateISO | true | none | Datetime in ISO format |
» tokenLink | string | false | none | Candidate token link |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | candidateTokenBase | false | none | none |
candidateTokenArray
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"tokenLink": "1BlgIvCY20NjUXlRj",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validToken": true
}
]
Array of candidate tokens
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [candidateToken] | false | none | Array of candidate tokens |
candidateTokenCreate
{
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validToken": true
}
Create Candidate Token body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
candidateId | UUID_V4 | true | none | Unique identifier for the entity |
validToken | candidateTokenValid | false | none | Is valid candidate token |
candidateTokenBase
{
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validToken": true
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
candidateId | UUID_V4 | false | none | Unique identifier for the entity |
validToken | candidateTokenValid | false | none | Is valid candidate token |
candidateTokenUpdate
{
"validToken": true
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
validToken | candidateTokenValid | false | none | Is valid candidate token |
candidateTokenValid
true
Is valid candidate token
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | boolean | false | none | Is valid candidate token |
candidateTokenFindResponse
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"tokenLink": "1BlgIvCY20NjUXlRj",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validToken": true,
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
}
]
Candidate Token Collection
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | candidateToken | false | none | Candidate Token |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | candidateTokenRelations | false | none | Candidate Token included relations |
candidateTokenFindByIdResponse
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"tokenLink": "1BlgIvCY20NjUXlRj",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validToken": true,
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
}
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | candidateToken | false | none | Candidate Token |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | candidateTokenRelations | false | none | Candidate Token included relations |
candidateTokenFindByLinkResponse
{
"token": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Candidate Token included relations
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
token | UUID_V4 | false | none | Unique identifier for the entity |
candidateTokenRelations
{
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
}
Candidate Token included relations
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
candidate | candidate | false | none | Related Candidate |
candidateTag
{
"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"
}
Model for linking candidates and tags.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | true | none | Unique identifier for the entity |
tagId | UUID_V4 | true | none | Unique identifier for the entity |
companyId | UUID_V4 | true | none | Unique identifier for the entity |
candidateId | UUID_V4 | true | none | Unique identifier for the entity |
createdAt | DateISO | true | none | Datetime in ISO format |
candidateTagArray
[
{
"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"
}
]
Array of candidate tags
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [candidateTag] | false | none | Array of candidate tags |
candidateTagCreate
[
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
An array of tag IDs to create for the candidate
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [UUID_V4] | false | none | An array of tag IDs to create for the candidate |
candidateTagDelete
[
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
An array of tag IDs to delete for the candidate
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [UUID_V4] | false | none | An array of tag IDs to delete for the candidate |
candidateSelfie
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"frontThumbnailId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isLocked": false,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"frontId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"leftId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"rightId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | false | none | Unique identifier for the entity |
companyId | UUID_V4 | false | none | Unique identifier for the entity |
candidateId | UUID_V4 | false | none | Unique identifier for the entity |
frontThumbnailId | UUID_V4 | false | none | Unique identifier for the entity |
isLocked | boolean | false | none | Is Locked files updating |
createdAt | DateISO | false | none | Datetime in ISO format |
updatedAt | DateISO | false | none | Datetime in ISO format |
frontId | UUID_V4 | false | none | Unique identifier for the entity |
leftId | UUID_V4 | false | none | Unique identifier for the entity |
rightId | UUID_V4 | false | none | Unique identifier for the entity |
candidateSelfieArray
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"frontThumbnailId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isLocked": false,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"frontId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"leftId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"rightId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
Array of candidate selfies
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [candidateSelfie] | false | none | Array of candidate selfies |
candidateSelfieCreate
{
"frontId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"leftId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"rightId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Create Selfie body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
frontId | UUID_V4 | false | none | Unique identifier for the entity |
leftId | UUID_V4 | false | none | Unique identifier for the entity |
rightId | UUID_V4 | false | none | Unique identifier for the entity |
candidateId | UUID_V4 | true | none | Unique identifier for the entity |
candidateSelfieUpdate
{
"frontId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"leftId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"rightId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Update Candidate Selfie body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
frontId | UUID_V4 | false | none | Unique identifier for the entity |
leftId | UUID_V4 | false | none | Unique identifier for the entity |
rightId | UUID_V4 | false | none | Unique identifier for the entity |
candidateSelfieFindResponse
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"frontThumbnailId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isLocked": false,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"frontId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"leftId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"rightId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"frontThumbnail": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
},
"front": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
},
"left": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
},
"right": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
}
}
]
Candidate selfie collection
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | candidateSelfie | false | none | none |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | candidateSelfieRelations | false | none | Candidate selfie included relations |
candidateSelfieFindByIdResponse
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"frontThumbnailId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isLocked": false,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"frontId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"leftId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"rightId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"frontThumbnail": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
},
"front": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
},
"left": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
},
"right": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
}
}
Candidate selfie with relations
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | candidateSelfie | false | none | none |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | candidateSelfieRelations | false | none | Candidate selfie included relations |
candidateSelfieRelations
{
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"frontThumbnail": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
},
"front": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
},
"left": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
},
"right": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
}
}
Candidate selfie included relations
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
candidate | candidate | false | none | Related candidate |
frontThumbnail | file | false | none | Related front thumbnail file |
front | file | false | none | Related front file |
left | file | false | none | Related left file |
right | file | false | none | Related right file |
candidateLogMessageActivity
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"scenarioId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"templateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"method": "email",
"partNbr": 1,
"triggerType": "automatic",
"webhooks": "string",
"uniqueEventId": "string",
"target": "[email protected]",
"delayedSending": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Notification activity log for a candidate
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | false | none | Unique identifier for the entity |
companyId | UUID_V4 | false | none | Unique identifier for the entity |
accountId | UUID_V4 | false | none | Unique identifier for the entity |
candidateId | UUID_V4 | false | none | Unique identifier for the entity |
scenarioId | UUID_V4 | false | none | Unique identifier for the entity |
templateId | UUID_V4 | false | none | Unique identifier for the entity |
method | candidateLogMessageActivityMethod | false | none | Candidate notification method |
partNbr | number | false | none | Part of the sms message |
triggerType | candidateLogMessageActivityTriggerType | false | none | Notification trigger type |
webhooks | string | false | none | none |
uniqueEventId | string | false | none | none |
target | string | false | none | Email or phone number of the recipient |
delayedSending | DateISO | false | none | Datetime in ISO format |
createdAt | DateISO | false | none | Datetime in ISO format |
updatedAt | DateISO | false | none | Datetime in ISO format |
candidateLogMessageActivityMethod
"email"
Candidate notification method
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | Candidate notification method |
Enumerated Values
Property | Value |
---|---|
anonymous | |
anonymous | sms |
candidateLogMessageActivityTriggerType
"automatic"
Notification trigger type
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | Notification trigger type |
Enumerated Values
Property | Value |
---|---|
anonymous | manually |
anonymous | automatic |
candidateCustomFieldBase
{
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "1234-456-32"
}
Base properties of candidate custom field
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
candidateId | UUID_V4 | false | none | Unique identifier for the entity |
customFieldId | UUID_V4 | false | none | Unique identifier for the entity |
value | candidateCustomFieldValue | false | none | The value can have different type depending on the Custom Field type |
candidateCustomField
{
"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 custom field
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | object | false | none | Immutable custom field properties |
» id | UUID_V4 | true | none | Unique identifier for the entity |
» createdAt | DateISO | true | none | Datetime in ISO format |
» updatedAt | DateISO | true | none | Datetime in ISO format |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | candidateCustomFieldBase | false | none | Base properties of candidate custom field |
candidateCustomFieldArray
[
{
"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"
}
]
Array of candidate custom fields
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [candidateCustomField] | false | none | Array of candidate custom fields |
candidateCustomFieldCreate
{
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "1234-456-32"
}
Custom field properties on create
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
candidateId | UUID_V4 | true | none | Unique identifier for the entity |
customFieldId | UUID_V4 | true | none | Unique identifier for the entity |
value | candidateCustomFieldValue | false | none | The value can have different type depending on the Custom Field type |
candidateCustomFieldUpdate
{
"value": "1234-456-32"
}
Body for updating custom field
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
value | string | true | none | The value of the candidate's custom field. |
candidateCustomFieldToUpdateByCandidate
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Document Number",
"fieldType": "string",
"orderNbr": 3,
"value": "1234-456-32",
"visibilityRules": {
"visible": true,
"editable": true,
"mandatory": false
}
}
Schema of candidate custom field to update by candidate
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | true | none | Unique identifier for the entity |
name | string | true | none | Visible name of the custom field. |
fieldType | string | true | none | Custom field type (only string is supported) |
orderNbr | number | true | none | Priority / order of the custom field in the list. |
value | string | true | none | none |
visibilityRules | customFieldVisibilityRulesOptions | true | none | Visibility rules for the entity |
candidateCustomFieldsToUpdateByCandidate
{
"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
}
}
]
}
Schema to update candidate custom fields by candidate
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
customFields | [candidateCustomFieldToUpdateByCandidate] | false | none | Array of candidate custom fields to update |
candidateCustomFieldRelations
{
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"customField": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Document Number",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"reference": "DOC_NUM",
"fieldType": "string",
"description": "This custom field is required to store the passport series.",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"visibilityRules": {
"admin": {
"visible": true,
"editable": true,
"mandatory": false
},
"candidate": {
"visible": true,
"editable": true,
"mandatory": false
}
},
"accountIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"docTypeIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"orderNbr": 3
}
}
Candidate custom field included relations
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
candidate | candidate | false | none | Related Candidate |
customField | customField | false | none | Related Custom Field |
candidateCustomFieldFindResponse
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "1234-456-32",
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"customField": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Document Number",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"reference": "DOC_NUM",
"fieldType": "string",
"description": "This custom field is required to store the passport series.",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"visibilityRules": {
"admin": {
"visible": true,
"editable": true,
"mandatory": false
},
"candidate": {
"visible": true,
"editable": true,
"mandatory": false
}
},
"accountIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"docTypeIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"orderNbr": 3
}
}
]
Candidate custom field collection
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | candidateCustomField | false | none | Candidate custom field |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | candidateCustomFieldRelations | false | none | Candidate custom field included relations |
candidateCustomFieldFindByIdResponse
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "1234-456-32",
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"customField": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Document Number",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"reference": "DOC_NUM",
"fieldType": "string",
"description": "This custom field is required to store the passport series.",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"visibilityRules": {
"admin": {
"visible": true,
"editable": true,
"mandatory": false
},
"candidate": {
"visible": true,
"editable": true,
"mandatory": false
}
},
"accountIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"docTypeIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"orderNbr": 3
}
}
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | candidateCustomField | false | none | Candidate custom field |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | candidateCustomFieldRelations | false | none | Candidate custom field included relations |
candidateCustomFieldValue
"1234-456-32"
Properties
oneOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | String custom field value |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | Date custom field value (based on Company locale date format) |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | Email custom field value |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | Simple List selected option |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [string] | false | none | Multiple List selected options |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | object | false | none | Simple Query selected option |
» label | string | true | none | Option Label |
» value | string | true | none | Option Value |
» id | string | false | none | Option unique field |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [object] | false | none | Multiple Query selected options |
» label | string | true | none | Option Label |
» value | string | true | none | Option Value |
» id | string | false | none | Option unique field |
candidateDocumentStat
{
"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"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | false | none | Unique identifier for the entity |
candidateId | UUID_V4 | false | none | Unique identifier for the entity |
docRequestedTotal | number | false | none | Requested documents amount |
docProvidedTotal | number | false | none | Provided documents amount |
docMandatoryRequestedTotal | number | false | none | Mandatory Requested documents amount |
docMandatoryProvidedTotal | number | false | none | Mandatory Provided documents amount |
docOptionalRequestedTotal | number | false | none | Optional Requested documents amount |
docOptionalProvidedTotal | number | false | none | Optional Provided documents amount |
resourceTotal | number | false | none | Resources amount |
resourceCompletedTotal | number | false | none | Completed resources amount |
createdAt | DateISO | true | none | Datetime in ISO format |
updatedAt | DateISO | false | none | Datetime in ISO format |
candidateDocumentType
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"internal": false,
"folder": "string",
"customStatus": "pending",
"ocrParsedData": {},
"validationSnapshot": {
"total": 10,
"totalToBePending": 10,
"conditions": [
{
"type": "or",
"action": "score",
"score": 10,
"sequence": 1,
"isValid": true,
"validations": [
{
"rule": "string",
"method": "contains",
"value": {
"value": "value"
},
"fieldName": "firstName",
"fieldValue": "Field value",
"sequence": 1,
"isValid": true
}
]
}
]
},
"integrationTransferedAt": "string",
"mergeSetFilePath": "string",
"isMultiple": false,
"isProcessing": false,
"isPaused": false,
"combinedMultipleDocumentPath": "string",
"combinedMultipleDocumentName": "string",
"expiresOn": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false
}
Candidate Document Type properties
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | false | none | Unique identifier for the entity |
documentTypeId | UUID_V4 | true | none | Unique identifier for the entity |
candidateId | UUID_V4 | true | none | Unique identifier for the entity |
name | string | true | none | Candidate Document Type name |
description | string | false | none | Candidate Document Type description |
internal | boolean | false | none | It says that Candidate Document Type is for system internal using |
folder | string | false | none | Candidate Document Type files folder name |
customStatus | candidateDocumentTypeStatus | false | none | Candidate Document Type Custom status name |
ocrParsedData | object | false | none | Data of the parsing result |
validationSnapshot | candidateDocumentTypeValidationSnapshot | false | none | Validation data |
integrationTransferedAt | string | false | none | Candidate Document Type integration transfer datetime |
mergeSetFilePath | string | false | none | Candidate Document Type merge set file path |
isMultiple | boolean | false | none | It says that it can be multiple document and consist of several parts. This option depends on company isMultipleUploadEnabled option |
isProcessing | boolean | false | none | It says that file is processing by some of the internal tasks (parsing, validating and etc) |
isPaused | boolean | false | none | Cancels the automatic confirm of the document if the uploading is not confirmed manually. |
combinedMultipleDocumentPath | string | false | none | PDF file path of combined multiple document parts |
combinedMultipleDocumentName | string | false | none | PDF file name of combined multiple document parts |
expiresOn | DateISO | false | none | Date when a candidate document type is expired. Date can be updated after extracting the expired at date from the document |
createdAt | DateISO | false | none | Datetime in ISO format |
updatedAt | DateISO | false | none | Datetime in ISO format |
filename | string | true | none | Document type filename. It can include dynamic fields like {candidateFirstname} |
comment | string | false | none | Candidate Document Type comment |
commentType | candidateDocumentTypeCommentType | false | none | Candidate document type comment type |
mandatory | boolean | true | none | It says that Candidate Document Type is mandatory or optional for the candidate |
candidateDocumentTypeArray
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"internal": false,
"folder": "string",
"customStatus": "pending",
"ocrParsedData": {},
"validationSnapshot": {
"total": 10,
"totalToBePending": 10,
"conditions": [
{
"type": "or",
"action": "score",
"score": 10,
"sequence": 1,
"isValid": true,
"validations": [
{
"rule": "string",
"method": "contains",
"value": {
"value": "value"
},
"fieldName": "firstName",
"fieldValue": "Field value",
"sequence": 1,
"isValid": true
}
]
}
]
},
"integrationTransferedAt": "string",
"mergeSetFilePath": "string",
"isMultiple": false,
"isProcessing": false,
"isPaused": false,
"combinedMultipleDocumentPath": "string",
"combinedMultipleDocumentName": "string",
"expiresOn": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false
}
]
Array of candidate document types
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [candidateDocumentType] | false | none | Array of candidate document types |
candidateDocumentTypeCreate
{
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false,
"folder": "string"
}
Create Candidate Document Type body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
documentTypeId | UUID_V4 | true | none | Unique identifier for the entity |
candidateId | UUID_V4 | true | none | Unique identifier for the entity |
name | string | false | none | Candidate Document Type name |
description | string | false | none | Candidate Document Type description |
filename | string | false | none | Document type filename. It can include dynamic fields like {candidateFirstname} |
comment | string | false | none | Candidate Document Type comment |
commentType | candidateDocumentTypeCommentType | false | none | Candidate document type comment type |
mandatory | boolean | true | none | It says that Candidate Document Type is mandatory or optional for the candidate |
folder | string | false | none | Candidate Document Type files folder name |
candidateDocumentTypeStatus
"pending"
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | none |
Enumerated Values
Property | Value |
---|---|
anonymous | provided |
anonymous | pending |
anonymous | validated |
anonymous | expired |
anonymous | rejected |
candidateDocumentTypeCommentType
"info"
Candidate document type comment type
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | Candidate document type comment type |
Enumerated Values
Property | Value |
---|---|
anonymous | info |
anonymous | success |
anonymous | warning |
anonymous | danger |
candidateDocumentTypeFindResponse
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"internal": false,
"folder": "string",
"customStatus": "pending",
"ocrParsedData": {},
"validationSnapshot": {
"total": 10,
"totalToBePending": 10,
"conditions": [
{
"type": "or",
"action": "score",
"score": 10,
"sequence": 1,
"isValid": true,
"validations": [
{
"rule": "string",
"method": "contains",
"value": {
"value": "value"
},
"fieldName": "firstName",
"fieldValue": "Field value",
"sequence": 1,
"isValid": true
}
]
}
]
},
"integrationTransferedAt": "string",
"mergeSetFilePath": "string",
"isMultiple": false,
"isProcessing": false,
"isPaused": false,
"combinedMultipleDocumentPath": "string",
"combinedMultipleDocumentName": "string",
"expiresOn": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false,
"documentType": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"name": "ASAP",
"reference": "dt_asap_eu",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"description": "Document Type description",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validationType": "auto",
"integrationSendOriginal": false,
"convertToPDF": false,
"isUnique": false,
"expiresInMonths": 2,
"isRectoVerso": false,
"advancedUploader": false,
"advancedUploaderSettings": {
"upload": false,
"scenario": "MrzAndLocate"
},
"skipBackup": false
},
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"documents": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"pdfFileName": "string",
"originFilePath": "string",
"originFileName": "string",
"thumbnailFilePath": "string",
"imageContentType": "image/jpeg",
"imageFileSize": 2952386,
"pdfFilePath": "string",
"isProcessing": false,
"position": 1
}
],
"customFields": [
{
"customField": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Document Number",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"reference": "DOC_NUM",
"fieldType": "string",
"description": "This custom field is required to store the passport series.",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"visibilityRules": {
"admin": {
"visible": true,
"editable": true,
"mandatory": false
},
"candidate": {
"visible": true,
"editable": true,
"mandatory": false
}
},
"accountIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"docTypeIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"orderNbr": 3
},
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "1234-456-32"
}
],
"faceMatch": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"similarity": 0.999332,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"images": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"type": "portrait",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
}
]
Candidate Document Type Collection
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | false | none | Unique identifier for the entity |
documentTypeId | UUID_V4 | true | none | Unique identifier for the entity |
candidateId | UUID_V4 | true | none | Unique identifier for the entity |
name | string | true | none | Candidate Document Type name |
description | string | false | none | Candidate Document Type description |
internal | boolean | false | none | It says that Candidate Document Type is for system internal using |
folder | string | false | none | Candidate Document Type files folder name |
customStatus | candidateDocumentTypeStatus | false | none | Candidate Document Type Custom status name |
ocrParsedData | object | false | none | Data of the parsing result |
validationSnapshot | candidateDocumentTypeValidationSnapshot | false | none | Validation data |
integrationTransferedAt | string | false | none | Candidate Document Type integration transfer datetime |
mergeSetFilePath | string | false | none | Candidate Document Type merge set file path |
isMultiple | boolean | false | none | It says that it can be multiple document and consist of several parts. This option depends on company isMultipleUploadEnabled option |
isProcessing | boolean | false | none | It says that file is processing by some of the internal tasks (parsing, validating and etc) |
isPaused | boolean | false | none | Cancels the automatic confirm of the document if the uploading is not confirmed manually. |
combinedMultipleDocumentPath | string | false | none | PDF file path of combined multiple document parts |
combinedMultipleDocumentName | string | false | none | PDF file name of combined multiple document parts |
expiresOn | DateISO | false | none | Date when a candidate document type is expired. Date can be updated after extracting the expired at date from the document |
createdAt | DateISO | false | none | Datetime in ISO format |
updatedAt | DateISO | false | none | Datetime in ISO format |
filename | string | true | none | Document type filename. It can include dynamic fields like {candidateFirstname} |
comment | string | false | none | Candidate Document Type comment |
commentType | candidateDocumentTypeCommentType | false | none | Candidate document type comment type |
mandatory | boolean | true | none | It says that Candidate Document Type is mandatory or optional for the candidate |
documentType | documentType | false | none | Related Document Type |
candidate | candidate | false | none | Related Candidate |
documents | [candidateDocument] | false | none | Related Candidate Documents |
customFields | [documentCustomFieldWithIncludedCustomField] | false | none | Related Document Custom Fields |
faceMatch | candidateDocumentTypeFaceMatch | false | none | Related Face Match result for the candidate document type |
images | [candidateDocumentTypeImage] | false | none | Related Document Images |
candidateDocumentTypeFindByIdResponse
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"internal": false,
"folder": "string",
"customStatus": "pending",
"ocrParsedData": {},
"validationSnapshot": {
"total": 10,
"totalToBePending": 10,
"conditions": [
{
"type": "or",
"action": "score",
"score": 10,
"sequence": 1,
"isValid": true,
"validations": [
{
"rule": "string",
"method": "contains",
"value": {
"value": "value"
},
"fieldName": "firstName",
"fieldValue": "Field value",
"sequence": 1,
"isValid": true
}
]
}
]
},
"integrationTransferedAt": "string",
"mergeSetFilePath": "string",
"isMultiple": false,
"isProcessing": false,
"isPaused": false,
"combinedMultipleDocumentPath": "string",
"combinedMultipleDocumentName": "string",
"expiresOn": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false,
"documentType": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"name": "ASAP",
"reference": "dt_asap_eu",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"description": "Document Type description",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validationType": "auto",
"integrationSendOriginal": false,
"convertToPDF": false,
"isUnique": false,
"expiresInMonths": 2,
"isRectoVerso": false,
"advancedUploader": false,
"advancedUploaderSettings": {
"upload": false,
"scenario": "MrzAndLocate"
},
"skipBackup": false
},
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"documents": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"pdfFileName": "string",
"originFilePath": "string",
"originFileName": "string",
"thumbnailFilePath": "string",
"imageContentType": "image/jpeg",
"imageFileSize": 2952386,
"pdfFilePath": "string",
"isProcessing": false,
"position": 1
}
],
"customFields": [
{
"customField": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Document Number",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"reference": "DOC_NUM",
"fieldType": "string",
"description": "This custom field is required to store the passport series.",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"visibilityRules": {
"admin": {
"visible": true,
"editable": true,
"mandatory": false
},
"candidate": {
"visible": true,
"editable": true,
"mandatory": false
}
},
"accountIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"docTypeIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"orderNbr": 3
},
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "1234-456-32"
}
],
"faceMatch": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"similarity": 0.999332,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"images": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"type": "portrait",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
}
Candidate Document Type properties
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | false | none | Unique identifier for the entity |
documentTypeId | UUID_V4 | true | none | Unique identifier for the entity |
candidateId | UUID_V4 | true | none | Unique identifier for the entity |
name | string | true | none | Candidate Document Type name |
description | string | false | none | Candidate Document Type description |
internal | boolean | false | none | It says that Candidate Document Type is for system internal using |
folder | string | false | none | Candidate Document Type files folder name |
customStatus | candidateDocumentTypeStatus | false | none | Candidate Document Type Custom status name |
ocrParsedData | object | false | none | Data of the parsing result |
validationSnapshot | candidateDocumentTypeValidationSnapshot | false | none | Validation data |
integrationTransferedAt | string | false | none | Candidate Document Type integration transfer datetime |
mergeSetFilePath | string | false | none | Candidate Document Type merge set file path |
isMultiple | boolean | false | none | It says that it can be multiple document and consist of several parts. This option depends on company isMultipleUploadEnabled option |
isProcessing | boolean | false | none | It says that file is processing by some of the internal tasks (parsing, validating and etc) |
isPaused | boolean | false | none | Cancels the automatic confirm of the document if the uploading is not confirmed manually. |
combinedMultipleDocumentPath | string | false | none | PDF file path of combined multiple document parts |
combinedMultipleDocumentName | string | false | none | PDF file name of combined multiple document parts |
expiresOn | DateISO | false | none | Date when a candidate document type is expired. Date can be updated after extracting the expired at date from the document |
createdAt | DateISO | false | none | Datetime in ISO format |
updatedAt | DateISO | false | none | Datetime in ISO format |
filename | string | true | none | Document type filename. It can include dynamic fields like {candidateFirstname} |
comment | string | false | none | Candidate Document Type comment |
commentType | candidateDocumentTypeCommentType | false | none | Candidate document type comment type |
mandatory | boolean | true | none | It says that Candidate Document Type is mandatory or optional for the candidate |
documentType | documentType | false | none | Related Document Type |
candidate | candidate | false | none | Related Candidate |
documents | [candidateDocument] | false | none | Related Candidate Documents |
customFields | [documentCustomFieldWithIncludedCustomField] | false | none | Related Document Custom Fields |
faceMatch | candidateDocumentTypeFaceMatch | false | none | Related Face Match result for the candidate document type |
images | [candidateDocumentTypeImage] | false | none | Related Document Images |
candidateDocumentTypeUpdateBody
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customStatus": "validated",
"comment": "string",
"commentType": "info"
}
]
Update Candidate Document Types body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | false | none | Unique identifier for the entity |
customStatus | string | false | none | Custom Status of the candidate document type |
comment | string | false | none | Candidate Document Type comment |
commentType | candidateDocumentTypeCommentType | false | none | Candidate document type comment type |
Enumerated Values
Property | Value |
---|---|
customStatus | validated |
customStatus | rejected |
candidateDocumentTypeUpdateCandidateDocumentsBody
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"position": 1
}
]
Update Candidate Documents body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | false | none | Unique identifier for the entity |
position | number | false | none | Candidate document position |
candidateDocumentTypeChangeBody
{
"create": [
{
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false,
"folder": "string"
}
],
"delete": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
}
Change Candidate Document Types body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
create | [candidateDocumentTypeCreate] | false | none | [Create Candidate Document Type body params] |
delete | [object] | false | none | none |
» id | UUID_V4 | false | none | Unique identifier for the entity |
candidateDocumentTypeChangeResponse
{
"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": "pending",
"ocrParsedData": {},
"validationSnapshot": {
"total": 10,
"totalToBePending": 10,
"conditions": [
{
"type": "or",
"action": "score",
"score": 10,
"sequence": 1,
"isValid": true,
"validations": [
{
"rule": "string",
"method": "contains",
"value": {
"value": "value"
},
"fieldName": "firstName",
"fieldValue": "Field value",
"sequence": 1,
"isValid": true
}
]
}
]
},
"integrationTransferedAt": "string",
"mergeSetFilePath": "string",
"isMultiple": false,
"isProcessing": false,
"isPaused": false,
"combinedMultipleDocumentPath": "string",
"combinedMultipleDocumentName": "string",
"expiresOn": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false
}
]
}
Change Candidate Document Types response
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
created | [candidateDocumentType] | false | none | Candidate document type |
candidateDocumentTypeValidationSnapshot
{
"total": 10,
"totalToBePending": 10,
"conditions": [
{
"type": "or",
"action": "score",
"score": 10,
"sequence": 1,
"isValid": true,
"validations": [
{
"rule": "string",
"method": "contains",
"value": {
"value": "value"
},
"fieldName": "firstName",
"fieldValue": "Field value",
"sequence": 1,
"isValid": true
}
]
}
]
}
Candidate Document Type Validation Snapshot
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
total | number | false | none | The total score of validated group scores |
totalToBePending | number | false | none | The total score to be pending of validated group scores |
conditions | [candidateDocumentTypeValidationSnapshotCondition] | false | none | Validation snapshot group conditions |
candidateDocumentTypeValidationSnapshotCondition
{
"type": "or",
"action": "score",
"score": 10,
"sequence": 1,
"isValid": true,
"validations": [
{
"rule": "string",
"method": "contains",
"value": {
"value": "value"
},
"fieldName": "firstName",
"fieldValue": "Field value",
"sequence": 1,
"isValid": true
}
]
}
Candidate Document Type Validation Snapshot Condition
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
type | string | false | none | Condition group type |
action | string | false | none | Condition group action |
score | number | false | none | Condition group score |
sequence | number | false | none | Condition sequence number |
isValid | boolean | false | none | Is condition group valid |
validations | [candidateDocumentTypeValidationSnapshotConditionValidation] | false | none | Condition validations |
Enumerated Values
Property | Value |
---|---|
type | or |
type | and |
action | score |
action | rejectedDocument |
action | validatedDocument |
action | pendingDocument |
candidateDocumentTypeValidationSnapshotConditionValidation
{
"rule": "string",
"method": "contains",
"value": {
"value": "value"
},
"fieldName": "firstName",
"fieldValue": "Field value",
"sequence": 1,
"isValid": true
}
Candidate Document Type Validation Snapshot Condition Validation
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
rule | string | false | none | Validation rule description |
method | string | false | none | Validation method |
value | object | false | none | Validation value |
» value | string | false | none | Validation value |
fieldName | string | false | none | Validation field name |
fieldValue | candidateDocumentTypeValidationSnapshotConditionValidationFieldValue | false | none | Validation field value |
sequence | number | false | none | Validation sequence number |
isValid | boolean | false | none | Is Validation valid |
Enumerated Values
Property | Value |
---|---|
method | empty |
method | equally |
method | contains |
method | inList |
method | notInList |
method | notEqual |
method | notEmpty |
method | notContains |
method | dateBetween |
method | dateBeforeFixed |
method | dateAfterFixed |
method | dateBeforePeriod |
method | dateAfterPeriod |
method | faceMatchSimilarityMore |
method | faceMatchSimilarityMoreOrEqual |
method | faceMatchSimilarityLess |
method | faceMatchSimilarityLessOrEqual |
candidateDocumentTypeValidationSnapshotConditionValidationFieldValue
"Field value"
Properties
oneOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | Field value |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | number | false | none | Field value |
candidateDocumentTypeFaceMatch
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"similarity": 0.999332,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | false | none | Unique identifier for the entity |
candidateDocumentTypeId | UUID_V4 | false | none | Unique identifier for the entity |
similarity | number | false | none | The Face Matching similarity result |
createdAt | DateISO | false | none | Datetime in ISO format |
updatedAt | DateISO | false | none | Datetime in ISO format |
candidateDocumentTypeImage
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"type": "portrait",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | false | none | Unique identifier for the entity |
candidateDocumentTypeId | UUID_V4 | false | none | Unique identifier for the entity |
fileId | UUID_V4 | false | none | Unique identifier for the entity |
type | candidateDocumentTypeImageType | false | none | One of Image type enumeration |
createdAt | DateISO | false | none | Datetime in ISO format |
updatedAt | DateISO | false | none | Datetime in ISO format |
candidateDocumentTypeImageType
"portrait"
One of Image type enumeration
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | One of Image type enumeration |
Enumerated Values
Property | Value |
---|---|
anonymous | portrait |
anonymous | selfie |
candidateDocument
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"pdfFileName": "string",
"originFilePath": "string",
"originFileName": "string",
"thumbnailFilePath": "string",
"imageContentType": "image/jpeg",
"imageFileSize": 2952386,
"pdfFilePath": "string",
"isProcessing": false,
"position": 1
}
Candidate Document properties
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | false | none | Unique identifier for the entity |
documentTypeId | UUID_V4 | true | none | Unique identifier for the entity |
candidateId | UUID_V4 | true | none | Unique identifier for the entity |
candidateDocumentTypeId | UUID_V4 | true | none | Unique identifier for the entity |
name | string | true | none | Candidate Document Type name |
createdAt | DateISO | false | none | Datetime in ISO format |
updatedAt | DateISO | false | none | Datetime in ISO format |
pdfFileName | string | false | none | Document Pdf converted filename |
originFilePath | string | false | none | Original file path |
originFileName | string | false | none | Original filename |
thumbnailFilePath | string | false | none | Document thumbnail file path |
imageContentType | string | false | none | Document file content type |
imageFileSize | number | false | none | Document file size |
pdfFilePath | string | false | none | Document Pdf converted file path |
isProcessing | boolean | false | none | It says that file is processing by some of the internal tasks (parsing, validating and etc) |
position | number | false | none | Document position |
candidateDocumentArray
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"pdfFileName": "string",
"originFilePath": "string",
"originFileName": "string",
"thumbnailFilePath": "string",
"imageContentType": "image/jpeg",
"imageFileSize": 2952386,
"pdfFilePath": "string",
"isProcessing": false,
"position": 1
}
]
Array of candidate documents
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [candidateDocument] | false | none | Array of candidate documents |
candidateResourceBase
{
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies"
}
Base properties of candidate resource
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
candidateId | UUID_V4 | false | none | Unique identifier for the entity |
resourceId | UUID_V4 | false | none | Unique identifier for the entity |
actions | resourceActions | false | none | Resource actions (at least one action required) |
blocking | boolean | false | none | Used for resources that must be completed before starting to work with documents. |
folder | string | false | none | 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. |
candidateResource
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Manager's contract",
"locked": false,
"text": "<p>It's the contract.</p>",
"completedActions": [
"complete",
"download"
],
"file": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"filename": "Contract J.J. Mask.pdf",
"remoteFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFilename": "Contract_example.pdf",
"fields": [
{
"reference": "Mask",
"value": {
"checkbox": false,
"text": "Mask",
"email": "Mask",
"signature": "data:image/png;base64,iVBORw0KGg"
}
}
],
"status": "requested",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies"
}
Candidate resource
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | object | false | none | Immutable resource properties |
» id | UUID_V4 | true | none | Unique identifier for the entity |
» companyId | UUID_V4 | false | none | Unique identifier for the entity |
» accountId | UUID_V4 | false | none | Unique identifier for the entity |
» name | string | true | none | The name of the original resource, in case it gets deleted. |
» locked | boolean | true | none | If the candidate has performed any action with the resource - the resource will be marked with this flag and can no longer be changed. |
» text | string | false | none | Resource content. |
» completedActions | resourceActions | false | none | Actions that the candidate has already completed with the resource. |
» file | string | false | none | File key for the candidate resource. |
» filename | string | false | none | File name for the candidate resource. |
» remoteFile | string | false | none | File key in remote storage. |
» attachedFile | string | false | none | File key that is attached to the original resource. |
» attachedFilename | string | false | none | File name that is attached to the original resource. |
» fields | candidateResourceFields | false | none | Array of candidate resources dynamic field value |
» status | candidateResourceStatus | false | none | Candidate Resource status |
» createdAt | DateISO | false | none | Datetime in ISO format |
» updatedAt | DateISO | false | none | Datetime in ISO format |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | candidateResourceBase | false | none | Base properties of candidate resource |
candidateResourceArray
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Manager's contract",
"locked": false,
"text": "<p>It's the contract.</p>",
"completedActions": [
"complete",
"download"
],
"file": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"filename": "Contract J.J. Mask.pdf",
"remoteFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFilename": "Contract_example.pdf",
"fields": [
{
"reference": "Mask",
"value": {
"checkbox": false,
"text": "Mask",
"email": "Mask",
"signature": "data:image/png;base64,iVBORw0KGg"
}
}
],
"status": "requested",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies"
}
]
Array of candidate resources
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [candidateResource] | false | none | Array of candidate resources |
candidateResourceCreate
{
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies"
}
Resource properties on create
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
candidateId | UUID_V4 | true | none | Unique identifier for the entity |
resourceId | UUID_V4 | true | none | Unique identifier for the entity |
actions | resourceActions | false | none | Resource actions (at least one action required) |
blocking | boolean | false | none | Used for resources that must be completed before starting to work with documents. |
folder | string | false | none | 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. |
candidateResourceUpdate
{
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies"
}
Body for updating candidate resource
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
actions | resourceActions | false | none | Resource actions (at least one action required) |
blocking | boolean | false | none | Used for resources that must be completed before starting to work with documents. |
folder | string | false | none | 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. |
candidateResourceRelations
{
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"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"
}
}
Candidate resource included relations
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
candidate | candidate | false | none | Related Candidate |
resource | resource | false | none | Related Resource |
candidateResourceFindResponse
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Manager's contract",
"locked": false,
"text": "<p>It's the contract.</p>",
"completedActions": [
"complete",
"download"
],
"file": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"filename": "Contract J.J. Mask.pdf",
"remoteFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFilename": "Contract_example.pdf",
"fields": [
{
"reference": "Mask",
"value": {
"checkbox": false,
"text": "Mask",
"email": "Mask",
"signature": "data:image/png;base64,iVBORw0KGg"
}
}
],
"status": "requested",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies",
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"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"
}
}
]
Candidate resource collection
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | candidateResource | false | none | Candidate resource |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | candidateResourceRelations | false | none | Candidate resource included relations |
candidateResourceFindByIdResponse
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Manager's contract",
"locked": false,
"text": "<p>It's the contract.</p>",
"completedActions": [
"complete",
"download"
],
"file": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"filename": "Contract J.J. Mask.pdf",
"remoteFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFilename": "Contract_example.pdf",
"fields": [
{
"reference": "Mask",
"value": {
"checkbox": false,
"text": "Mask",
"email": "Mask",
"signature": "data:image/png;base64,iVBORw0KGg"
}
}
],
"status": "requested",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies",
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"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"
}
}
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | candidateResource | false | none | Candidate resource |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | candidateResourceRelations | false | none | Candidate resource included relations |
candidateResourceField
{
"reference": "Mask",
"value": {
"checkbox": false,
"text": "Mask",
"email": "Mask",
"signature": "data:image/png;base64,iVBORw0KGg"
}
}
Candidate resource dynamic field value
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
reference | string | false | none | Reference of the dynamic field in the resource. |
value | object | false | none | none |
» checkbox | boolean | false | none | Dynamic field value. (present only if the field type is checkbox) |
» text | string | false | none | Dynamic field value. (present only if the field type is text) |
string | false | none | Dynamic field value. (present only if the field type is email) | |
» signature | string | false | none | Base64 string (present only if the field type is signature) |
candidateResourceFields
[
{
"reference": "Mask",
"value": {
"checkbox": false,
"text": "Mask",
"email": "Mask",
"signature": "data:image/png;base64,iVBORw0KGg"
}
}
]
Array of candidate resources dynamic field value
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [candidateResourceField] | false | none | Array of candidate resources dynamic field value |
candidateResourceComplete
{
"fields": {
"{field reference for checkbox}": false,
"{field reference for text}": "Mask",
"{field reference for signature}": "data:image/png;base64,iVBORw0KGg"
}
}
Body for editable candidate resources (only for complete
action)
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
fields | object | false | none | Mapping of references and their actual values filled in by the candidate. |
» {field reference for checkbox} | boolean | false | none | The value chosen by the candidate. |
» {field reference for text} | string | false | none | The value entered by the candidate. |
» {field reference for signature} | string | false | none | Base64 signature image. |
candidateResourceDelete
{
"ids": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"locked": false,
"blocking": false
}
Body for deleting candidate resources
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
ids | [UUID_V4] | false | none | [Unique identifier for the entity] |
candidateId | UUID_V4 | false | none | Unique identifier for the entity |
resourceId | UUID_V4 | false | none | Unique identifier for the entity |
locked | boolean | false | none | none |
blocking | boolean | false | none | none |
candidateResourceGetEditableContentResponse
{
"text": "<p>It's the contract for Elon Mask.</p>"
}
The body of the response for resource content in the context of a candidate.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
text | string | false | none | Content with pre-filled fields for the candidate. |
candidateResourceChangeBody
{
"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"
}
]
}
Change Candidate Resources body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
create | [candidateResourceCreate] | false | none | [Resource properties on create] |
delete | [object] | false | none | none |
» id | UUID_V4 | false | none | Unique identifier for the entity |
candidateResourceChangeResponse
{
"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": {
"checkbox": false,
"text": "Mask",
"email": "Mask",
"signature": "data:image/png;base64,iVBORw0KGg"
}
}
],
"status": "requested",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies"
}
]
}
Change Candidate Resources response
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
created | [candidateResource] | false | none | Candidate resource |
candidateResourceStatus
"requested"
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | none |
Enumerated Values
Property | Value |
---|---|
anonymous | requested |
anonymous | pending |
anonymous | completed |
candidateForm
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Initial",
"folder": "Registration",
"actions": [
"complete",
"download"
],
"completedActions": [
"complete",
"download"
],
"isLocked": false,
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"isPdfGenerationEnabled": false,
"pdfFilePath": "pdf/file/path",
"pdfFileName": "string",
"remotePdfFilePath": "string",
"status": "requested",
"type": "editable",
"isAddition": false,
"parentId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"metadata": {},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Candidate Form properties
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | true | none | Unique identifier for the entity |
companyId | UUID_V4 | true | none | Unique identifier for the entity |
candidateId | UUID_V4 | false | none | Unique identifier for the entity |
formId | UUID_V4 | false | none | Unique identifier for the entity |
accountId | UUID_V4 | false | none | Unique identifier for the entity |
fileId | UUID_V4 | false | none | Candidate form file id. It is needed for form with attached file |
signatureId | UUID_V4 | false | none | Candidate form signature id. It should be used only when action 'eSign' is included |
name | string | true | none | Form name |
folder | string | false | none | Folder name |
actions | formActions | false | none | Form actions (at least one action required); Please note that allowable actions depend on the type of the original form:
|
completedActions | formActions | false | none | Form actions (at least one action required); Please note that allowable actions depend on the type of the original form:
|
isLocked | boolean | false | none | Is Candidate Form locked |
isMandatory | boolean | false | none | Is Candidate Form mandatory |
isPreliminary | boolean | false | none | Is candidate form preliminary |
isBlocking | boolean | false | none | Is the candidate screen blocking by the form popup |
filename | string | false | none | Candidate Form name |
isPdfGenerationEnabled | boolean | false | none | Is candidate form pdf generation enabled |
pdfFilePath | string | false | none | Candidate Form pdf file path |
pdfFileName | string | false | none | Candidate Form pdf file name |
remotePdfFilePath | string | false | none | Candidate Form remote pdf file path |
status | candidateFormStatus | false | none | Candidate Form status |
type | formType | false | none | One of Form type enumeration |
isAddition | boolean | false | none | Is candidate form is addition of Combo Form |
parentId | UUID_V4 | false | none | Unique identifier for the entity |
metadata | object | false | none | Candidate Form metadata (external properties) |
createdAt | DateISO | true | none | Datetime in ISO format |
updatedAt | DateISO | true | none | Datetime in ISO format |
candidateFormFindResponse
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Initial",
"folder": "Registration",
"actions": [
"complete",
"download"
],
"completedActions": [
"complete",
"download"
],
"isLocked": false,
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"isPdfGenerationEnabled": false,
"pdfFilePath": "pdf/file/path",
"pdfFileName": "string",
"remotePdfFilePath": "string",
"status": "requested",
"type": "editable",
"isAddition": false,
"parentId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"metadata": {},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"form": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Work Permit",
"reference": "work_permit",
"shareCode": "",
"type": "editable",
"language": "en",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"updatedById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"additions": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Initial",
"folder": "Registration",
"actions": [
"complete",
"download"
],
"completedActions": [
"complete",
"download"
],
"isLocked": false,
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"isPdfGenerationEnabled": false,
"pdfFilePath": "pdf/file/path",
"pdfFileName": "string",
"remotePdfFilePath": "string",
"status": "requested",
"type": "editable",
"isAddition": false,
"parentId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"metadata": {},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
}
]
Candidate Form Collection
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | true | none | Unique identifier for the entity |
companyId | UUID_V4 | true | none | Unique identifier for the entity |
candidateId | UUID_V4 | false | none | Unique identifier for the entity |
formId | UUID_V4 | false | none | Unique identifier for the entity |
accountId | UUID_V4 | false | none | Unique identifier for the entity |
fileId | UUID_V4 | false | none | Candidate form file id. It is needed for form with attached file |
signatureId | UUID_V4 | false | none | Candidate form signature id. It should be used only when action 'eSign' is included |
name | string | true | none | Form name |
folder | string | false | none | Folder name |
actions | formActions | false | none | Form actions (at least one action required); Please note that allowable actions depend on the type of the original form:
|
completedActions | formActions | false | none | Form actions (at least one action required); Please note that allowable actions depend on the type of the original form:
|
isLocked | boolean | false | none | Is Candidate Form locked |
isMandatory | boolean | false | none | Is Candidate Form mandatory |
isPreliminary | boolean | false | none | Is candidate form preliminary |
isBlocking | boolean | false | none | Is the candidate screen blocking by the form popup |
filename | string | false | none | Candidate Form name |
isPdfGenerationEnabled | boolean | false | none | Is candidate form pdf generation enabled |
pdfFilePath | string | false | none | Candidate Form pdf file path |
pdfFileName | string | false | none | Candidate Form pdf file name |
remotePdfFilePath | string | false | none | Candidate Form remote pdf file path |
status | candidateFormStatus | false | none | Candidate Form status |
type | formType | false | none | One of Form type enumeration |
isAddition | boolean | false | none | Is candidate form is addition of Combo Form |
parentId | UUID_V4 | false | none | Unique identifier for the entity |
metadata | object | false | none | Candidate Form metadata (external properties) |
createdAt | DateISO | true | none | Datetime in ISO format |
updatedAt | DateISO | true | none | Datetime in ISO format |
form | form | false | none | Related Form |
candidate | candidate | false | none | Related Candidate |
additions | [candidateForm] | false | none | Array of addition candidate forms |
candidateFormFindByIdResponse
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Initial",
"folder": "Registration",
"actions": [
"complete",
"download"
],
"completedActions": [
"complete",
"download"
],
"isLocked": false,
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"isPdfGenerationEnabled": false,
"pdfFilePath": "pdf/file/path",
"pdfFileName": "string",
"remotePdfFilePath": "string",
"status": "requested",
"type": "editable",
"isAddition": false,
"parentId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"metadata": {},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"form": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Work Permit",
"reference": "work_permit",
"shareCode": "",
"type": "editable",
"language": "en",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"updatedById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"data": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateFormId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fields": {},
"context": {},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"additions": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Initial",
"folder": "Registration",
"actions": [
"complete",
"download"
],
"completedActions": [
"complete",
"download"
],
"isLocked": false,
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"isPdfGenerationEnabled": false,
"pdfFilePath": "pdf/file/path",
"pdfFileName": "string",
"remotePdfFilePath": "string",
"status": "requested",
"type": "editable",
"isAddition": false,
"parentId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"metadata": {},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
}
Candidate Form properties
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | true | none | Unique identifier for the entity |
companyId | UUID_V4 | true | none | Unique identifier for the entity |
candidateId | UUID_V4 | false | none | Unique identifier for the entity |
formId | UUID_V4 | false | none | Unique identifier for the entity |
accountId | UUID_V4 | false | none | Unique identifier for the entity |
fileId | UUID_V4 | false | none | Candidate form file id. It is needed for form with attached file |
signatureId | UUID_V4 | false | none | Candidate form signature id. It should be used only when action 'eSign' is included |
name | string | true | none | Form name |
folder | string | false | none | Folder name |
actions | formActions | false | none | Form actions (at least one action required); Please note that allowable actions depend on the type of the original form:
|
completedActions | formActions | false | none | Form actions (at least one action required); Please note that allowable actions depend on the type of the original form:
|
isLocked | boolean | false | none | Is Candidate Form locked |
isMandatory | boolean | false | none | Is Candidate Form mandatory |
isPreliminary | boolean | false | none | Is candidate form preliminary |
isBlocking | boolean | false | none | Is the candidate screen blocking by the form popup |
filename | string | false | none | Candidate Form name |
isPdfGenerationEnabled | boolean | false | none | Is candidate form pdf generation enabled |
pdfFilePath | string | false | none | Candidate Form pdf file path |
pdfFileName | string | false | none | Candidate Form pdf file name |
remotePdfFilePath | string | false | none | Candidate Form remote pdf file path |
status | candidateFormStatus | false | none | Candidate Form status |
type | formType | false | none | One of Form type enumeration |
isAddition | boolean | false | none | Is candidate form is addition of Combo Form |
parentId | UUID_V4 | false | none | Unique identifier for the entity |
metadata | object | false | none | Candidate Form metadata (external properties) |
createdAt | DateISO | true | none | Datetime in ISO format |
updatedAt | DateISO | true | none | Datetime in ISO format |
form | form | false | none | Related Form |
candidate | candidate | false | none | Related Candidate |
data | candidateFormData | false | none | Related Data |
additions | [candidateForm] | false | none | Array of addition candidate forms |
candidateFormSuccessResponse
{
"success": true
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
success | boolean | false | none | none |
candidateFormComplete
{
"fields": {
"{field reference for checkbox}": false,
"{field reference for text}": "Mask"
}
}
Body for editable candidate forms (only for complete
action)
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
fields | object | false | none | Mapping of references and their actual values filled in by the candidate. |
» {field reference for checkbox} | boolean | false | none | The value chosen by the candidate. |
» {field reference for text} | string | false | none | The value entered by the candidate. |
candidateFormCreateBody
{
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"isPreliminary": false,
"folder": "Registration",
"metadata": {},
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Create Candidate Form body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
candidateId | UUID_V4 | true | none | Unique identifier for the entity |
formId | UUID_V4 | true | none | Unique identifier for the entity |
actions | formActions | true | none | Form actions (at least one action required); Please note that allowable actions depend on the type of the original form:
|
isMandatory | boolean | false | none | Is candidate form mandatory |
isPreliminary | boolean | false | none | Is candidate form preliminary |
folder | string | false | none | Folder name |
metadata | object | false | none | Candidate Form metadata (external properties) |
fileId | UUID_V4 | false | none | Candidate form file id |
signatureId | UUID_V4 | false | none | Candidate form signature id |
candidateFormChangeResponse
{
"created": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Initial",
"folder": "Registration",
"actions": [
"complete",
"download"
],
"completedActions": [
"complete",
"download"
],
"isLocked": false,
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"isPdfGenerationEnabled": false,
"pdfFilePath": "pdf/file/path",
"pdfFileName": "string",
"remotePdfFilePath": "string",
"status": "requested",
"type": "editable",
"isAddition": false,
"parentId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"metadata": {},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
}
Change Candidate Forms response
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
created | [candidateForm] | false | none | Candidate form |
candidateFormStatus
"requested"
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | none |
Enumerated Values
Property | Value |
---|---|
anonymous | requested |
anonymous | pending |
anonymous | completed |
candidateFormData
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateFormId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fields": {},
"context": {},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Candidate form data properties
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | true | none | Unique identifier for the entity |
candidateFormId | UUID_V4 | true | none | Unique identifier for the entity |
fields | object | true | none | Candidate Form fields |
context | object | false | none | Candidate form data context |
createdAt | DateISO | true | none | Datetime in ISO format |
updatedAt | DateISO | true | none | Datetime in ISO format |
candidateFormDataUpdateByIdBody
{
"fields": {},
"context": {}
}
Update candidate form data body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
fields | object | false | none | Candidate form data fields |
context | object | false | none | Candidate form data context |
candidateFormContent
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateFormId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"content": {},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Candidate form content properties
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | true | none | Unique identifier for the entity |
candidateFormId | UUID_V4 | true | none | Unique identifier for the entity |
content | object | true | none | Form content |
createdAt | DateISO | true | none | Datetime in ISO format |
updatedAt | DateISO | true | none | Datetime in ISO format |
candidateFormContentUpdateByIdBody
{
"content": {}
}
Update candidate form content body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
content | object | true | none | Candidate form content |
candidatePreset
{
"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"
]
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": true,
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
}
Candidate Preset for handling candidate event.
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | object | false | none | none |
» id | UUID_V4 | true | none | Unique identifier for the entity |
» companyId | UUID_V4 | true | none | Unique identifier for the entity |
» createdAt | DateISO | true | none | Datetime in ISO format |
» updatedAt | DateISO | true | none | Datetime in ISO format |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | candidatePresetBase | false | none | none |
candidatePresetArray
[
{
"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"
]
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": true,
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
}
]
Array of candidatePresets
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [candidatePreset] | false | none | Array of candidatePresets |
candidatePresetCreate
{
"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"
]
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": true,
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
}
Create Candidate Preset body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
name | string | true | none | Candidate Preset name |
reference | string | false | none | Candidate Preset reference |
docTypes | candidatePresetDocTypes | false | none | Documents to be applied to the candidate. |
resources | candidatePresetResources | false | none | Resources to be applied to the candidate. |
forms | candidatePresetForms | false | none | Forms to be applied to the candidate. |
candidatePresetBase
{
"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"
]
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": true,
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
name | string | true | none | Candidate Preset name |
reference | string | false | none | Candidate Preset reference |
docTypes | candidatePresetDocTypes | false | none | Documents to be applied to the candidate. |
resources | candidatePresetResources | false | none | Resources to be applied to the candidate. |
forms | candidatePresetForms | false | none | Forms to be applied to the candidate. |
candidatePresetUpdate
{
"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"
]
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": true,
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
name | string | true | none | Candidate Preset name |
reference | string | false | none | Candidate Preset reference |
docTypes | candidatePresetDocTypes | false | none | Documents to be applied to the candidate. |
resources | candidatePresetResources | false | none | Resources to be applied to the candidate. |
forms | candidatePresetForms | false | none | Forms to be applied to the candidate. |
candidatePresetFindResponse
[
{
"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"
]
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": true,
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
],
"company": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it",
"pl",
"ro",
"sq",
"be",
"bg",
"hr",
"cs",
"da",
"et",
"fi",
"el",
"hu",
"is",
"ga",
"lv",
"lt",
"mk",
"mt",
"no",
"pt",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"uk",
"cy"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
}
}
]
Candidate Preset Collection
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | candidatePreset | false | none | Candidate Preset for handling candidate event. |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | candidatePresetRelations | false | none | Candidate Preset included relations |
candidatePresetFindByIdResponse
{
"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"
]
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": true,
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
],
"company": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it",
"pl",
"ro",
"sq",
"be",
"bg",
"hr",
"cs",
"da",
"et",
"fi",
"el",
"hu",
"is",
"ga",
"lv",
"lt",
"mk",
"mt",
"no",
"pt",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"uk",
"cy"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
}
}
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | candidatePreset | false | none | Candidate Preset for handling candidate event. |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | candidatePresetRelations | false | none | Candidate Preset included relations |
candidatePresetRelations
{
"company": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it",
"pl",
"ro",
"sq",
"be",
"bg",
"hr",
"cs",
"da",
"et",
"fi",
"el",
"hu",
"is",
"ga",
"lv",
"lt",
"mk",
"mt",
"no",
"pt",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"uk",
"cy"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
}
}
Candidate Preset included relations
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
company | company | false | none | Related Company |
candidatePresetDocType
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "(Copy of the passport)",
"comment": "Some comment",
"folder": "Some comment",
"commentType": "info",
"mandatory": false
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | true | none | Document type id |
name | string | false | none | Alternative name for document (for example, if added several identical document types.) |
comment | string | false | none | Comment for document |
folder | string | false | none | Folder for document |
commentType | candidateDocumentTypeCommentType | false | none | Candidate document type comment type |
mandatory | boolean | false | none | Folder for document |
candidatePresetDocTypes
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "(Copy of the passport)",
"comment": "Some comment",
"folder": "Some comment",
"commentType": "info",
"mandatory": false
}
]
Documents to be applied to the candidate.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [candidatePresetDocType] | false | none | Documents to be applied to the candidate. |
candidatePresetResource
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
]
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | true | none | Resource id |
actions | resourceActions | true | none | Resource actions (at least one action required) |
candidatePresetResources
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
]
}
]
Resources to be applied to the candidate.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [candidatePresetResource] | false | none | Resources to be applied to the candidate. |
candidatePresetForm
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": true,
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | true | none | Unique identifier for the entity |
actions | formActions | true | none | Form actions |
isMandatory | boolean | true | none | It says that form is mandatory or optional for the candidate. |
signatureId | UUID_V4 | false | none | Signature id which you want to attach with the form. |
candidatePresetForms
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"isMandatory": true,
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
Forms to be applied to the candidate.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [candidatePresetForm] | false | none | Forms to be applied to the candidate. |
companyBase
{
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it",
"pl",
"ro",
"sq",
"be",
"bg",
"hr",
"cs",
"da",
"et",
"fi",
"el",
"hu",
"is",
"ga",
"lv",
"lt",
"mk",
"mt",
"no",
"pt",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"uk",
"cy"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
}
Base properties of company entity
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
name | string | false | none | Company name |
zipAllCandidateDocumentsFileName | string | false | none | Company candidate's documents zip file name |
replyToEmail | string | false | none | Company reply to email |
archiveInactiveCandidateAfterDays | number | false | none | Days amount to keep inactive candidates before they will be archived |
deleteInactiveCandidateAfterDays | number | false | none | Days amount to keep candidates before they will be deleted |
logo | string | false | none | Company logo |
languages | companyLanguages | false | none | Company languages (at least one language required) |
fileBoxCss | string | false | none | Custom fileBox styles |
largeDocumentThumbnail | boolean | false | none | Company document preview use large or small thumbnail |
isMultipleUploadEnabled | boolean | false | none | Allow uploading of multi-part documents |
maxNumberOfFilesPerDocument | number | false | none | The number of files that can be uploaded into one multipart document. |
isCandidateConversationEnabled | boolean | false | none | Allow candidate conversation |
locale | companyLocale | false | none | Company Locale |
company
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it",
"pl",
"ro",
"sq",
"be",
"bg",
"hr",
"cs",
"da",
"et",
"fi",
"el",
"hu",
"is",
"ga",
"lv",
"lt",
"mk",
"mt",
"no",
"pt",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"uk",
"cy"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
}
Properties for Company entity
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | object | false | none | Immutable company properties |
» id | UUID_V4 | true | none | Unique identifier for the entity |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | companyBase | false | none | Base properties of company entity |
companyLanguages
[
"en",
"fr",
"nl",
"de",
"it",
"pl",
"ro",
"sq",
"be",
"bg",
"hr",
"cs",
"da",
"et",
"fi",
"el",
"hu",
"is",
"ga",
"lv",
"lt",
"mk",
"mt",
"no",
"pt",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"uk",
"cy"
]
Company languages (at least one language required)
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [companyLanguage] | false | none | Company languages (at least one language required) |
companyLanguage
"en"
Company language
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | Company language |
Enumerated Values
Property | Value |
---|---|
anonymous | en |
anonymous | fr |
anonymous | nl |
anonymous | de |
anonymous | it |
anonymous | pl |
anonymous | ro |
anonymous | sq |
anonymous | be |
anonymous | bg |
anonymous | hr |
anonymous | cs |
anonymous | da |
anonymous | et |
anonymous | fi |
anonymous | el |
anonymous | hu |
anonymous | is |
anonymous | ga |
anonymous | lv |
anonymous | lt |
anonymous | mk |
anonymous | mt |
anonymous | no |
anonymous | pt |
anonymous | ru |
anonymous | sr |
anonymous | sk |
anonymous | sl |
anonymous | es |
anonymous | sv |
anonymous | uk |
anonymous | cy |
companyLocale
{
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
Company Locale
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
key | string | false | none | Locale key |
country | string | false | none | Locale country |
lang | string | false | none | Locale language key |
dateFormat | string | false | none | Locale format |
code | string | false | none | Locale country code |
phoneCode | string | false | none | Locale phone number code |
Enumerated Values
Property | Value |
---|---|
lang | en |
lang | fr |
lang | nl |
lang | de |
lang | it |
lang | pl |
lang | ro |
lang | sq |
lang | be |
lang | bg |
lang | hr |
lang | cs |
lang | da |
lang | et |
lang | fi |
lang | el |
lang | hu |
lang | is |
lang | ga |
lang | lv |
lang | lt |
lang | mk |
lang | mt |
lang | no |
lang | pt |
lang | ru |
lang | sr |
lang | sk |
lang | sl |
lang | es |
lang | sv |
lang | uk |
lang | cy |
companyValidateReference
{
"reference": "example value",
"ownId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"model": "candidate"
}
Company validation reference body fields
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
reference | string | true | none | Reference value |
ownId | UUID_V4 | false | none | Model id |
model | string | true | none | Company related model |
Enumerated Values
Property | Value |
---|---|
model | account |
model | customField |
model | candidate |
model | candidatePreset |
model | scenario |
model | documentType |
model | form |
companyValidateReferenceResponse
{
"isValid": true,
"isValidString": true,
"isUnique": true
}
Company reference validation response
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
isValid | boolean | false | none | Reference is valid |
isValidString | boolean | false | none | Reference string is valid |
isUnique | boolean | false | none | Reference is unique |
companyPublicDataResponse
{
"name": "The Best Company",
"logo": ""
}
Company public data
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
name | string | true | none | Company name |
logo | string | false | none | Company logo |
companyFindByIdResponse
{
"accounts": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"aboutText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedBoxText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
],
"policy": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"adminUsers": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"lastActivityAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"isOwner": false
}
],
"companyGroup": {
"name": "Administrative group",
"createdAt": "2019-09-12T15:36:09.264Z"
},
"documentTypes": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"name": "ASAP",
"reference": "dt_asap_eu",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"description": "Document Type description",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validationType": "auto",
"integrationSendOriginal": false,
"convertToPDF": false,
"isUnique": false,
"expiresInMonths": 2,
"isRectoVerso": false,
"advancedUploader": false,
"advancedUploaderSettings": {
"upload": false,
"scenario": "MrzAndLocate"
},
"skipBackup": false
}
],
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it",
"pl",
"ro",
"sq",
"be",
"bg",
"hr",
"cs",
"da",
"et",
"fi",
"el",
"hu",
"is",
"ga",
"lv",
"lt",
"mk",
"mt",
"no",
"pt",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"uk",
"cy"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
}
Find by id company response
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | object | false | none | Company included relations |
» accounts | [account] | false | none | Company accounts |
» policy | companyPolicy | false | none | Properties for Company Policy entity |
» adminUsers | [adminUser] | false | none | Company admin users |
» companyGroup | companyGroup | false | none | none |
» documentTypes | [documentType] | false | none | Company document types |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | company | false | none | Properties for Company entity |
companyEditByIdRequest
{
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it",
"pl",
"ro",
"sq",
"be",
"bg",
"hr",
"cs",
"da",
"et",
"fi",
"el",
"hu",
"is",
"ga",
"lv",
"lt",
"mk",
"mt",
"no",
"pt",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"uk",
"cy"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
},
"policy": {
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
}
}
Edit by id company request body
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | companyBase | false | none | Base properties of company entity |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | object | false | none | Company relations to update |
» policy | companyPolicyBase | false | none | This scheme is a collection of company policies for users in different languages. |
companyFindByMeResponse
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it",
"pl",
"ro",
"sq",
"be",
"bg",
"hr",
"cs",
"da",
"et",
"fi",
"el",
"hu",
"is",
"ga",
"lv",
"lt",
"mk",
"mt",
"no",
"pt",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"uk",
"cy"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
},
"policy": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
}
}
Find by my token company response
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | company | false | none | Properties for Company entity |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | object | false | none | Company included relations |
» policy | companyPolicy | false | none | Properties for Company Policy entity |
companyEditByIdResponse
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it",
"pl",
"ro",
"sq",
"be",
"bg",
"hr",
"cs",
"da",
"et",
"fi",
"el",
"hu",
"is",
"ga",
"lv",
"lt",
"mk",
"mt",
"no",
"pt",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"uk",
"cy"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
},
"policy": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
}
}
Edit by id company response
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | company | false | none | Properties for Company entity |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | object | false | none | Company updated relations |
» policy | companyPolicy | false | none | Properties for Company Policy entity |
companyPolicy
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
}
Properties for Company Policy entity
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | object | false | none | Immutable company policy properties |
» id | UUID_V4 | true | none | Unique identifier for the entity |
» companyId | UUID_V4 | true | none | Unique identifier for the entity |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | companyPolicyBase | false | none | This scheme is a collection of company policies for users in different languages. |
companyPolicyBase
{
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
}
This scheme is a collection of company policies for users in different languages.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
en | string(html) | false | none | Used for users whose language is "English" |
fr | string(html) | false | none | Used for users whose language is "Français" |
nl | string(html) | false | none | Used for users whose language is "Nederlands" |
de | string(html) | false | none | Used for users whose language is "Deutsch" |
it | string(html) | false | none | Used for users whose language is "Italiano" |
pl | string(html) | false | none | Used for users whose language is "Polski" |
ro | string(html) | false | none | Used for users whose language is "Română" |
sq | string(html) | false | none | Used for users whose language is "Shqip" |
be | string(html) | false | none | Used for users whose language is "Беларуская" |
bg | string(html) | false | none | Used for users whose language is "Български" |
hr | string(html) | false | none | Used for users whose language is "Hrvatski" |
cs | string(html) | false | none | Used for users whose language is "Čeština" |
da | string(html) | false | none | Used for users whose language is "Dansk" |
et | string(html) | false | none | Used for users whose language is "Eesti" |
fi | string(html) | false | none | Used for users whose language is "Suomi" |
el | string(html) | false | none | Used for users whose language is "Ελληνικά" |
hu | string(html) | false | none | Used for users whose language is "Magyar" |
is | string(html) | false | none | Used for users whose language is "Íslenska" |
ga | string(html) | false | none | Used for users whose language is "Gaeilge" |
lv | string(html) | false | none | Used for users whose language is "Latviešu" |
lt | string(html) | false | none | Used for users whose language is "Lietuvių" |
mk | string(html) | false | none | Used for users whose language is "Македонски" |
mt | string(html) | false | none | Used for users whose language is "Malti" |
no | string(html) | false | none | Used for users whose language is "Norsk" |
pt | string(html) | false | none | Used for users whose language is "Português" |
ru | string(html) | false | none | Used for users whose language is "Русский" |
sr | string(html) | false | none | Used for users whose language is "Српски" |
sk | string(html) | false | none | Used for users whose language is "Slovenčina" |
sl | string(html) | false | none | Used for users whose language is "Slovenščina" |
es | string(html) | false | none | Used for users whose language is "Español" |
sv | string(html) | false | none | Used for users whose language is "Svenska" |
uk | string(html) | false | none | Used for users whose language is "Українська" |
cy | string(html) | false | none | Used for users whose language is "Cymraeg" |
companyGroup
{
"name": "Administrative group",
"createdAt": "2019-09-12T15:36:09.264Z"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
name | string | true | none | Company Group Name |
createdAt | DateISO | true | none | Datetime in ISO format |
companySignatureRoleEntity
"adminUser"
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | none |
Enumerated Values
Property | Value |
---|---|
anonymous | adminUser |
anonymous | candidate |
companySignatureRoleBase
{
"name": "Company Signature role",
"entity": "adminUser",
"entityId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
name | string | false | none | Company signature role name |
entity | companySignatureRoleEntity | false | none | none |
entityId | UUID_V4 | false | none | Unique identifier for the entity |
companySignatureRole
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isDefault": false,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Company Signature role",
"entity": "adminUser",
"entityId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Company signature role
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | object | false | none | none |
» id | UUID_V4 | false | none | Unique identifier for the entity |
» companyId | UUID_V4 | false | none | Unique identifier for the entity |
» isDefault | boolean | false | none | Is company signature role is default |
» createdAt | DateISO | false | none | Datetime in ISO format |
» updatedAt | DateISO | false | none | Datetime in ISO format |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | companySignatureRoleBase | false | none | none |
companySignatureRoleCreate
{
"name": "Company Signature role",
"entity": "adminUser",
"entityId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Create Company Signature Role body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
name | string | true | none | Company signature role name |
entity | companySignatureRoleEntity | true | none | none |
entityId | UUID_V4 | true | none | Unique identifier for the entity |
companySignatureRoleUpdate
{
"name": "Company Signature role",
"entity": "adminUser",
"entityId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Update Company Signature Role body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
name | string | false | none | Company signature role name |
entity | companySignatureRoleEntity | false | none | none |
entityId | UUID_V4 | false | none | Unique identifier for the entity |
companySignatureRoleRelations
{
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"adminUser": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"lastActivityAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"isOwner": false
}
}
Company Signature role included relations
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
candidate | candidate | false | none | Related Candidate |
adminUser | adminUser | false | none | Related Admin User |
companySignatureRoleFindByIdResponse
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isDefault": false,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Company Signature role",
"entity": "adminUser",
"entityId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"adminUser": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"lastActivityAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"isOwner": false
}
}
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | companySignatureRole | false | none | Company signature role |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | companySignatureRoleRelations | false | none | Company Signature role included relations |
companySignatureRoleFindResponse
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isDefault": false,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Company Signature role",
"entity": "adminUser",
"entityId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidate": {
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"email": "[email protected]",
"firstName": "James",
"lastName": "Good",
"reference": "Best Candidate",
"language": "en",
"welcomeText": "Hi John, we are glad to welcome you to the company!",
"welcomeTextType": "default",
"assigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionalEmails": [
"[email protected]"
],
"snoozed": false,
"mobilePhone": "003801234567890",
"notes": "Some notes",
"deadline": "2019-09-12T15:36:09.264Z",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "pending",
"token": "2ScQsIW1OPHsjEFRs",
"archived": false,
"integrationChanged": false,
"clientIsMobile": false,
"clientVersion": "",
"lastLoggedAt": "2019-09-12T15:36:09.264Z",
"statusUpdateAt": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"adminUser": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"lastActivityAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"isOwner": false
}
}
]
Company Signature Role Collection
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | companySignatureRole | false | none | Company signature role |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | companySignatureRoleRelations | false | none | Company Signature role included relations |
customFieldBase
{
"name": "Document Number",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"reference": "DOC_NUM",
"fieldType": "string",
"description": "This custom field is required to store the passport series.",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"visibilityRules": {
"admin": {
"visible": true,
"editable": true,
"mandatory": false
},
"candidate": {
"visible": true,
"editable": true,
"mandatory": false
}
},
"accountIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"docTypeIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"orderNbr": 3
}
Base properties of custom field for an entity
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
name | string | false | none | Visible name of the custom field. |
nameI18n | translations | false | none | Custom field name translations |
reference | string | false | none | Unique custom identifier for the field |
fieldType | string | false | none | Custom field type |
description | string | false | none | Description of the custom field. |
descriptionI18n | translations | false | none | Custom field description translations |
visibilityRules | customFieldVisibilityRules | false | none | Visibility rules for the entity (admin or candidate). |
accountIds | [UUID_V4] | false | none | Array of account IDs for which this custom field can be used. Leave the array empty to apply to all accounts. |
docTypeIds | [UUID_V4] | false | none | Array of document type IDs for which this custom field can be used. Leave the array empty to apply to all document types. |
orderNbr | number | false | none | Priority / order of the custom field in the list. |
Enumerated Values
Property | Value |
---|---|
fieldType | string |
fieldType | |
fieldType | date |
customField
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Document Number",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"reference": "DOC_NUM",
"fieldType": "string",
"description": "This custom field is required to store the passport series.",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"visibilityRules": {
"admin": {
"visible": true,
"editable": true,
"mandatory": false
},
"candidate": {
"visible": true,
"editable": true,
"mandatory": false
}
},
"accountIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"docTypeIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"orderNbr": 3
}
Custom fields for an entity
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | object | false | none | Immutable custom field properties |
» id | UUID_V4 | true | none | Unique identifier for the entity |
» companyId | UUID_V4 | true | none | Unique identifier for the entity |
» createdAt | DateISO | true | none | Datetime in ISO format |
» updatedAt | DateISO | true | none | Datetime in ISO format |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | customFieldBase | false | none | Base properties of custom field for an entity |
customFieldArray
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Document Number",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"reference": "DOC_NUM",
"fieldType": "string",
"description": "This custom field is required to store the passport series.",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"visibilityRules": {
"admin": {
"visible": true,
"editable": true,
"mandatory": false
},
"candidate": {
"visible": true,
"editable": true,
"mandatory": false
}
},
"accountIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"docTypeIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"orderNbr": 3
}
]
Array of custom fields related to company
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [customField] | false | none | Array of custom fields related to company |
customFieldCreate
{
"name": "Document Number",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"reference": "DOC_NUM",
"model": "candidate",
"fieldType": "string",
"description": "This custom field is required to store the passport series.",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"visibilityRules": {
"admin": {
"visible": true,
"editable": true,
"mandatory": false
},
"candidate": {
"visible": true,
"editable": true,
"mandatory": false
}
},
"accountIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"docTypeIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"orderNbr": 3
}
Custom field properties on create
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
name | string | true | none | Visible name of the custom field. |
nameI18n | translations | false | none | Custom field name translations |
reference | string | true | none | Unique custom identifier for the field |
model | customFieldModel | true | none | The model for which this custom field is applied. |
fieldType | string | true | none | Custom field type |
description | string | false | none | Description of the custom field. |
descriptionI18n | translations | false | none | Custom field description translations |
visibilityRules | customFieldVisibilityRules | true | none | Visibility rules for the entity (admin or candidate). |
accountIds | [UUID_V4] | false | none | Array of account IDs for which this custom field can be used. Leave the array empty to apply to all accounts. |
docTypeIds | [UUID_V4] | false | none | Array of document type IDs for which this custom field can be used. Leave the array empty to apply to all document types. |
orderNbr | number | true | none | Priority / order of the custom field in the list. |
Enumerated Values
Property | Value |
---|---|
fieldType | string |
fieldType | |
fieldType | date |
customFieldUpdate
{
"name": "Document Number",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"reference": "DOC_NUM",
"fieldType": "string",
"description": "This custom field is required to store the passport series.",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"visibilityRules": {
"admin": {
"visible": true,
"editable": true,
"mandatory": false
},
"candidate": {
"visible": true,
"editable": true,
"mandatory": false
}
},
"accountIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"docTypeIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"orderNbr": 3
}
Custom field properties on update
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
name | string | false | none | Visible name of the custom field. |
nameI18n | translations | false | none | Custom field name translations |
reference | string | false | none | Unique custom identifier for the field |
fieldType | string | false | none | Custom field type |
description | string | false | none | Description of the custom field. |
descriptionI18n | translations | false | none | Custom field description translations |
visibilityRules | customFieldVisibilityRules | false | none | Visibility rules for the entity (admin or candidate). |
accountIds | [UUID_V4] | false | none | Array of account IDs for which this custom field can be used. Leave the array empty to apply to all accounts. |
docTypeIds | [UUID_V4] | false | none | Array of document type IDs for which this custom field can be used. Leave the array empty to apply to all document types. |
orderNbr | number | false | none | Priority / order of the custom field in the list. |
Enumerated Values
Property | Value |
---|---|
fieldType | string |
fieldType | |
fieldType | date |
customFieldVisibilityRules
{
"admin": {
"visible": true,
"editable": true,
"mandatory": false
},
"candidate": {
"visible": true,
"editable": true,
"mandatory": false
}
}
Visibility rules for the entity (admin or candidate).
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
admin | customFieldVisibilityRulesOptions | false | none | Visibility rules for the entity |
candidate | customFieldVisibilityRulesOptions | false | none | Visibility rules for the entity |
customFieldVisibilityRulesOptions
{
"visible": true,
"editable": true,
"mandatory": false
}
Visibility rules for the entity
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
visible | boolean | false | none | Is this field visible. |
editable | boolean | false | none | Is this field editable. |
mandatory | boolean | false | none | Is this field mandatory. |
customFieldModel
"candidate"
The model for which this custom field is applied.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | The model for which this custom field is applied. |
Enumerated Values
Property | Value |
---|---|
anonymous | candidate |
anonymous | document |
containerUpload
{
"{documentTypeId}": "There should be your file in binary format"
}
Upload file for candidate document type
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
{documentTypeId} | string(binary) | true | none | The file to be uploaded. |
containerUploadResponse
{
"result": {
"fields": {},
"files": {
"{documentTypeId}": [
{
"candidateDocumentId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"container": "7e4236be-b328-4905-8f91-e46b5b47f0b7",
"field": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "document.pdf",
"size": 394867,
"type": "application/pdf"
}
]
}
}
}
Container response after file upload
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
result | object | true | none | none |
» fields | object | false | none | none |
» files | object | false | none | none |
»» {documentTypeId} | [containerUploadResponseField] | false | none | [Response for one uploaded file] |
containerUploadResponseField
{
"candidateDocumentId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"container": "7e4236be-b328-4905-8f91-e46b5b47f0b7",
"field": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "document.pdf",
"size": 394867,
"type": "application/pdf"
}
Response for one uploaded file
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
candidateDocumentId | UUID_V4 | false | none | ID of the created candidate document. |
container | string | false | none | The file to be uploaded. |
field | UUID_V4 | false | none | Document type id |
name | string | false | none | Name of the uploaded file |
size | number | false | none | Size of the uploaded file |
type | number | false | none | Mimetype of the uploaded file |
daasRequest
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"parserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validatorId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "finished",
"validation": [
{
"type": "or",
"action": "score",
"score": 10,
"sequence": 1,
"isValid": true,
"validations": [
{
"rule": "string",
"method": "contains",
"value": {
"value": "value"
},
"fieldName": "firstName",
"fieldValue": "Field value",
"sequence": 1,
"isValid": true
}
]
}
],
"validationStatus": "validated",
"data": {},
"metadata": {},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | true | none | Unique identifier for the entity |
companyId | UUID_V4 | true | none | Unique identifier for the entity |
documentTypeId | UUID_V4 | true | none | Unique identifier for the entity |
parserId | UUID_V4 | true | none | Unique identifier for the entity |
validatorId | UUID_V4 | false | none | Unique identifier for the entity |
status | daasRequestStatus | true | none | Request status |
validation | [daasRequestValidationGroup] | false | none | Array of daas request validations |
validationStatus | daasRequestValidationStatus | false | none | Request status |
data | object | true | none | Data of the parsing result |
metadata | object | true | none | This object will not be changed and you will receive it in the integration callback. Also you should be aware that these fields can be used in the rules during validation process |
createdAt | DateISO | true | none | Datetime in ISO format |
updatedAt | DateISO | true | none | Datetime in ISO format |
daasRequestArray
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"parserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validatorId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "finished",
"validation": [
{
"type": "or",
"action": "score",
"score": 10,
"sequence": 1,
"isValid": true,
"validations": [
{
"rule": "string",
"method": "contains",
"value": {
"value": "value"
},
"fieldName": "firstName",
"fieldValue": "Field value",
"sequence": 1,
"isValid": true
}
]
}
],
"validationStatus": "validated",
"data": {},
"metadata": {},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
DAAS Request Collection
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [daasRequest] | false | none | DAAS Request Collection |
daasRequestCreate
{
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"files": [
"There should be your file in binary format"
],
"metadata": {}
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
documentTypeId | UUID_V4 | true | none | Unique identifier for the entity |
files | [string] | true | none | Daas request files |
metadata | object | false | none | This object will not be changed and you will receive it in the integration callback. Also you should be aware that these fields can be used in the rules during validation process |
daasRequestStatus
"finished"
Request status
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | Request status |
Enumerated Values
Property | Value |
---|---|
anonymous | accepted |
anonymous | uploading_start |
anonymous | uploading_end |
anonymous | uploading_error |
anonymous | converting_start |
anonymous | converting_end |
anonymous | converting_error |
anonymous | combining_start |
anonymous | combining_end |
anonymous | combining_error |
anonymous | parsing_start |
anonymous | parsing_end |
anonymous | parsing_error |
anonymous | validation_start |
anonymous | validation_end |
anonymous | validation_error |
anonymous | webhook_sending_start |
anonymous | webhook_sending_end |
anonymous | webhook_sending_error |
anonymous | finished |
daasRequestValidationStatus
"validated"
Request status
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | Request status |
Enumerated Values
Property | Value |
---|---|
anonymous | validated |
anonymous | pending |
anonymous | rejected |
daasRequestValidationGroup
{
"type": "or",
"action": "score",
"score": 10,
"sequence": 1,
"isValid": true,
"validations": [
{
"rule": "string",
"method": "contains",
"value": {
"value": "value"
},
"fieldName": "firstName",
"fieldValue": "Field value",
"sequence": 1,
"isValid": true
}
]
}
Daas Request Validation Group
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
type | string | false | none | Group type |
action | string | false | none | Group action |
score | number | false | none | Group score |
sequence | number | false | none | Group sequence number |
isValid | boolean | false | none | Is group valid |
validations | [daasRequestValidationGroupValidation] | false | none | Group validations |
Enumerated Values
Property | Value |
---|---|
type | or |
type | and |
action | score |
action | rejectedDocument |
action | validatedDocument |
action | pendingDocument |
daasRequestValidationGroupValidation
{
"rule": "string",
"method": "contains",
"value": {
"value": "value"
},
"fieldName": "firstName",
"fieldValue": "Field value",
"sequence": 1,
"isValid": true
}
Daas Request Validation Group Validation
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
rule | string | false | none | Group Validation rule description |
method | string | false | none | Group Validation method |
value | object | false | none | Group Validation value |
» value | string | false | none | Group Validation value |
fieldName | string | false | none | Group Validation field name |
fieldValue | daasRequestValidationGroupValidationFieldValue | false | none | Group Validation field value |
sequence | number | false | none | Group Validation sequence number |
isValid | boolean | false | none | Is Group Validation valid |
Enumerated Values
Property | Value |
---|---|
method | empty |
method | equally |
method | contains |
method | inList |
method | notInList |
method | notEqual |
method | notEmpty |
method | notContains |
method | dateBetween |
method | dateBeforeFixed |
method | dateAfterFixed |
method | dateBeforePeriod |
method | dateAfterPeriod |
method | faceMatchSimilarityMore |
method | faceMatchSimilarityMoreOrEqual |
method | faceMatchSimilarityLess |
method | faceMatchSimilarityLessOrEqual |
daasRequestValidationGroupValidationFieldValue
"Field value"
Properties
oneOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | Field value |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | number | false | none | Field value |
documentType
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"name": "ASAP",
"reference": "dt_asap_eu",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"description": "Document Type description",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validationType": "auto",
"integrationSendOriginal": false,
"convertToPDF": false,
"isUnique": false,
"expiresInMonths": 2,
"isRectoVerso": false,
"advancedUploader": false,
"advancedUploaderSettings": {
"upload": false,
"scenario": "MrzAndLocate"
},
"skipBackup": false
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | true | none | Unique identifier for the entity |
companyId | UUID_V4 | true | none | Unique identifier for the entity |
createdAt | DateISO | true | none | Datetime in ISO format |
updatedAt | DateISO | true | none | Datetime in ISO format |
filename | string | true | none | Document type filename. It can include dynamic fields like {candidateFirstname} |
name | string | true | none | Document type name |
reference | string | false | none | Document type reference |
nameI18n | translations | false | none | Document type name translations |
description | string | false | none | Document type description |
descriptionI18n | translations | false | none | Document type description translations |
documentParserId | UUID_V4 | false | none | Document parser id |
documentValidationSetId | UUID_V4 | false | none | Document validation id |
validationType | string | false | none | Document validation type |
integrationSendOriginal | boolean | false | none | It says that uploaded document original file should be send to integrations |
convertToPDF | boolean | false | none | It says that document should be converted to pdf |
isUnique | boolean | false | none | It says that document type should be unique for a candidate |
expiresInMonths | number | false | none | Document should be expired after the amount of months. |
isRectoVerso | boolean | false | none | It says that document must have two parts (front and back sides). Document parts will be combined to pdf file |
advancedUploader | boolean | false | none | Enables additional logic for uploading recto-verso documents |
advancedUploaderSettings | object | false | none | Extended settings for advanced uploader |
skipBackup | boolean | false | none | If this option is true, it will exclude all candidate documents related to this type from our backup system. |
Enumerated Values
Property | Value |
---|---|
validationType | auto |
validationType | manual |
validationType | always_valid |
documentTypeArray
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"name": "ASAP",
"reference": "dt_asap_eu",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"description": "Document Type description",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validationType": "auto",
"integrationSendOriginal": false,
"convertToPDF": false,
"isUnique": false,
"expiresInMonths": 2,
"isRectoVerso": false,
"advancedUploader": false,
"advancedUploaderSettings": {
"upload": false,
"scenario": "MrzAndLocate"
},
"skipBackup": false
}
]
Array of document types
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [documentType] | false | none | Array of document types |
documentTypeFindResponse
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"name": "ASAP",
"reference": "dt_asap_eu",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"description": "Document Type description",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validationType": "auto",
"integrationSendOriginal": false,
"convertToPDF": false,
"isUnique": false,
"expiresInMonths": 2,
"isRectoVerso": false,
"advancedUploader": false,
"advancedUploaderSettings": {
"upload": false,
"scenario": "MrzAndLocate"
},
"skipBackup": 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": "pending",
"ocrParsedData": {},
"validationSnapshot": {
"total": 10,
"totalToBePending": 10,
"conditions": [
{
"type": "or",
"action": "score",
"score": 10,
"sequence": 1,
"isValid": true,
"validations": [
{
"rule": "string",
"method": "contains",
"value": {
"value": "value"
},
"fieldName": "firstName",
"fieldValue": "Field value",
"sequence": 1,
"isValid": true
}
]
}
]
},
"integrationTransferedAt": "string",
"mergeSetFilePath": "string",
"isMultiple": false,
"isProcessing": false,
"isPaused": false,
"combinedMultipleDocumentPath": "string",
"combinedMultipleDocumentName": "string",
"expiresOn": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false
}
],
"mimeTypes": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": ".pdf name",
"extension": ".pdf",
"mime": "application/pdf",
"icon": ""
}
]
}
]
Document Type Collection
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | true | none | Unique identifier for the entity |
companyId | UUID_V4 | true | none | Unique identifier for the entity |
createdAt | DateISO | true | none | Datetime in ISO format |
updatedAt | DateISO | true | none | Datetime in ISO format |
filename | string | true | none | Document type filename. It can include dynamic fields like {candidateFirstname} |
name | string | true | none | Document type name |
reference | string | false | none | Document type reference |
nameI18n | translations | false | none | Document type name translations |
description | string | false | none | Document type description |
descriptionI18n | translations | false | none | Document type description translations |
documentParserId | UUID_V4 | false | none | Document parser id |
documentValidationSetId | UUID_V4 | false | none | Document validation id |
validationType | string | false | none | Document validation type |
integrationSendOriginal | boolean | false | none | It says that uploaded document original file should be send to integrations |
convertToPDF | boolean | false | none | It says that document should be converted to pdf |
isUnique | boolean | false | none | It says that document type should be unique for a candidate |
expiresInMonths | number | false | none | Document should be expired after the amount of months. |
isRectoVerso | boolean | false | none | It says that document must have two parts (front and back sides). Document parts will be combined to pdf file |
advancedUploader | boolean | false | none | Enables additional logic for uploading recto-verso documents |
advancedUploaderSettings | object | false | none | Extended settings for advanced uploader |
skipBackup | boolean | false | none | If this option is true, it will exclude all candidate documents related to this type from our backup system. |
candidateDocumentTypes | [candidateDocumentType] | false | none | Related Candidate Document Types |
mimeTypes | [mimeType] | false | none | Related Mime Types |
Enumerated Values
Property | Value |
---|---|
validationType | auto |
validationType | manual |
validationType | always_valid |
documentTypeFindOneResponse
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"name": "ASAP",
"reference": "dt_asap_eu",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"description": "Document Type description",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validationType": "auto",
"integrationSendOriginal": false,
"convertToPDF": false,
"isUnique": false,
"expiresInMonths": 2,
"isRectoVerso": false,
"advancedUploader": false,
"advancedUploaderSettings": {
"upload": false,
"scenario": "MrzAndLocate"
},
"skipBackup": false,
"mimeTypes": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": ".pdf name",
"extension": ".pdf",
"mime": "application/pdf",
"icon": ""
}
]
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | true | none | Unique identifier for the entity |
companyId | UUID_V4 | true | none | Unique identifier for the entity |
createdAt | DateISO | true | none | Datetime in ISO format |
updatedAt | DateISO | true | none | Datetime in ISO format |
filename | string | true | none | Document type filename. It can include dynamic fields like {candidateFirstname} |
name | string | true | none | Document type name |
reference | string | false | none | Document type reference |
nameI18n | translations | false | none | Document type name translations |
description | string | false | none | Document type description |
descriptionI18n | translations | false | none | Document type description translations |
documentParserId | UUID_V4 | false | none | Document parser id |
documentValidationSetId | UUID_V4 | false | none | Document validation id |
validationType | string | false | none | Document validation type |
integrationSendOriginal | boolean | false | none | It says that uploaded document original file should be send to integrations |
convertToPDF | boolean | false | none | It says that document should be converted to pdf |
isUnique | boolean | false | none | It says that document type should be unique for a candidate |
expiresInMonths | number | false | none | Document should be expired after the amount of months. |
isRectoVerso | boolean | false | none | It says that document must have two parts (front and back sides). Document parts will be combined to pdf file |
advancedUploader | boolean | false | none | Enables additional logic for uploading recto-verso documents |
advancedUploaderSettings | object | false | none | Extended settings for advanced uploader |
skipBackup | boolean | false | none | If this option is true, it will exclude all candidate documents related to this type from our backup system. |
mimeTypes | [mimeType] | false | none | Related Mime Types |
Enumerated Values
Property | Value |
---|---|
validationType | auto |
validationType | manual |
validationType | always_valid |
documentCustomField
{
"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"
}
Document custom field
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | object | false | none | Immutable custom field properties |
» id | UUID_V4 | true | none | Unique identifier for the entity |
» createdAt | DateISO | true | none | Datetime in ISO format |
» updatedAt | DateISO | true | none | Datetime in ISO format |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | documentCustomFieldBase | false | none | Base properties of document custom field |
documentCustomFieldBase
{
"candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "1234-456-32"
}
Base properties of document custom field
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
candidateDocumentTypeId | UUID_V4 | true | none | Unique identifier for the entity |
customFieldId | UUID_V4 | true | none | Unique identifier for the entity |
value | string | true | none | none |
documentCustomFieldWithIncludedCustomField
{
"customField": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Document Number",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"reference": "DOC_NUM",
"fieldType": "string",
"description": "This custom field is required to store the passport series.",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"visibilityRules": {
"admin": {
"visible": true,
"editable": true,
"mandatory": false
},
"candidate": {
"visible": true,
"editable": true,
"mandatory": false
}
},
"accountIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"docTypeIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"orderNbr": 3
},
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"value": "1234-456-32"
}
Document custom field
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
customField | customField | false | none | Document custom field relation |
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | object | false | none | Immutable custom field properties |
» id | UUID_V4 | true | none | Unique identifier for the entity |
» createdAt | DateISO | true | none | Datetime in ISO format |
» updatedAt | DateISO | true | none | Datetime in ISO format |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | documentCustomFieldBase | false | none | Base properties of document custom field |
documentMimeType
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"mimeTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Model for linking document type and mime type.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | true | none | Unique identifier for the entity |
documentTypeId | UUID_V4 | true | none | Unique identifier for the entity |
mimeTypeId | UUID_V4 | true | none | Unique identifier for the entity |
documentMimeTypeArray
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"mimeTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
Array of document mime types
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [documentMimeType] | false | none | Array of document mime types |
documentValidationSet
{
"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": "ID card validation",
"scoreToBeValid": 10,
"scoreToBePending": 1
}
Document validation set properties
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | object | false | none | none |
» id | UUID_V4 | true | none | Unique identifier for the entity |
» companyId | UUID_V4 | true | none | Unique identifier for the entity |
» createdAt | DateISO | false | none | Datetime in ISO format |
» updatedAt | DateISO | false | none | Datetime in ISO format |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | documentValidationSetBase | false | none | none |
documentValidationSetArray
[
{
"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": "ID card validation",
"scoreToBeValid": 10,
"scoreToBePending": 1
}
]
Array of document validation sets
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [documentValidationSet] | false | none | Array of document validation sets |
documentValidationSetCreate
{
"name": "ID card validation",
"scoreToBeValid": 10,
"scoreToBePending": 1,
"validationGroups": [
{
"validations": [
{
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string"
}
],
"type": "or",
"action": "score",
"score": 2,
"sequence": 1
}
]
}
Create document validation set body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
name | string | true | none | Document validation set name |
scoreToBeValid | number | false | none | The minimum number of points for the document to be considered as valid. |
scoreToBePending | number | false | none | The minimum number of points for the document to be considered as pending. |
validationGroups | [documentValidationSetValidationGroupCreate] | true | none | Array of document validation groups related to this validation set. Should be included min 1 item |
documentValidationSetBase
{
"name": "ID card validation",
"scoreToBeValid": 10,
"scoreToBePending": 1
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
name | string | false | none | Document validation set name |
scoreToBeValid | number | false | none | The minimum number of points for the document to be considered as valid. |
scoreToBePending | number | false | none | The minimum number of points for the document to be considered as pending. |
documentValidationSetUpdate
{
"name": "ID card validation",
"scoreToBeValid": 10,
"scoreToBePending": 1,
"validationGroups": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validations": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string"
}
],
"type": "or",
"action": "score",
"score": 2,
"sequence": 1
}
]
}
Updating document validation set body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
name | string | false | none | Document validation set name |
scoreToBeValid | number | false | none | The minimum number of points for the document to be considered as valid. |
scoreToBePending | number | false | none | The minimum number of points for the document to be considered as pending. |
validationGroups | [documentValidationSetValidationGroupUpdate] | false | none | Array of document validation groups related to this validation set |
documentValidationSetFindResponse
[
{
"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": "ID card validation",
"scoreToBeValid": 10,
"scoreToBePending": 1,
"validations": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string"
}
]
}
]
Document validation set collection
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | documentValidationSet | false | none | Document validation set properties |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | documentValidationSetRelations | false | none | Document validation set included relations |
documentValidationSetFindByIdResponse
{
"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": "ID card validation",
"scoreToBeValid": 10,
"scoreToBePending": 1,
"validations": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string"
}
]
}
Document validation set
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | documentValidationSet | false | none | Document validation set properties |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | documentValidationSetRelations | false | none | Document validation set included relations |
documentValidationSetRelations
{
"validations": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string"
}
]
}
Document validation set included relations
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
validations | documentValidationArray | false | none | Related validations |
documentValidationSetValidationGroupCreate
{
"validations": [
{
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string"
}
],
"type": "or",
"action": "score",
"score": 2,
"sequence": 1
}
Document validation set validation group properties
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | object | false | none | none |
» validations | [documentValidationBase] | true | none | Array of document validations related to this validation group. Should be included min 1 item |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | documentValidationGroupBase | false | none | none |
documentValidationSetValidationGroupUpdate
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validations": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string"
}
],
"type": "or",
"action": "score",
"score": 2,
"sequence": 1
}
Document validation set validation group properties
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | object | false | none | none |
» id | UUID_V4 | false | none | Unique identifier for the entity |
» companyId | UUID_V4 | false | none | Unique identifier for the entity |
» documentValidationSetId | UUID_V4 | false | none | Unique identifier for the entity |
» validations | [documentValidation] | false | none | Array of document validations related to this validation group. Should be included min 1 item |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | documentValidationGroupBase | false | none | none |
documentValidationGroup
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"type": "or",
"action": "score",
"score": 2,
"sequence": 1
}
Document validation group properties
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | object | false | none | none |
» id | UUID_V4 | true | none | Unique identifier for the entity |
» companyId | UUID_V4 | true | none | Unique identifier for the entity |
» documentValidationSetId | UUID_V4 | true | none | Unique identifier for the entity |
» createdAt | DateISO | false | none | Datetime in ISO format |
» updatedAt | DateISO | false | none | Datetime in ISO format |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | documentValidationGroupBase | false | none | none |
documentValidationGroupArray
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"type": "or",
"action": "score",
"score": 2,
"sequence": 1
}
]
Array of document validation groups
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [documentValidationGroup] | false | none | Array of document validation groups |
documentValidationGroupBase
{
"type": "or",
"action": "score",
"score": 2,
"sequence": 1
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
type | string | false | none | Validation group type. It defines how group should be validated based on the related rules validations. |
action | string | false | none | Validation group action. It defines what should to do immediately after validation this group with rules. |
score | number | false | none | The number of points that document receives when passing this group of rules. |
sequence | number | false | none | The sequence number to show validation groups in appropriate order |
Enumerated Values
Property | Value |
---|---|
type | or |
type | and |
action | score |
action | rejectedDocument |
action | validatedDocument |
action | pendingDocument |
documentValidationGroupCreate
[
{
"type": "or",
"action": "score",
"score": 2,
"sequence": 1,
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validations": [
{
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string"
}
]
}
]
Array of document validation groups to create
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [documentValidationGroupCreateOne] | false | none | Array of document validation groups to create |
documentValidationGroupCreateOne
{
"type": "or",
"action": "score",
"score": 2,
"sequence": 1,
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validations": [
{
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string"
}
]
}
Create document validation group body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
type | string | false | none | Validation group type. It defines how group should be validated based on the related rules validations. |
action | string | false | none | Validation group action. It defines what should to do immediately after validation this group with rules. |
score | number | false | none | The number of points that document receives when passing this group of rules. |
sequence | number | false | none | The sequence number to show validation groups in appropriate order |
documentValidationSetId | UUID_V4 | true | none | Unique identifier for the entity |
validations | [documentValidationBase] | true | none | Array of document validations related to this validation group. Should be included min 1 item |
Enumerated Values
Property | Value |
---|---|
type | or |
type | and |
action | score |
action | rejectedDocument |
action | validatedDocument |
action | pendingDocument |
documentValidationGroupDelete
{
"ids": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}
Delete document validation groups body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
ids | [UUID_V4] | false | none | Array of document validation group ids |
documentValidationGroupFindByIdResponse
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"type": "or",
"action": "score",
"score": 2,
"sequence": 1,
"documentValidationSet": {
"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": "ID card validation",
"scoreToBeValid": 10,
"scoreToBePending": 1
}
}
Document validation group with relations
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | documentValidationGroup | false | none | Document validation group properties |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | documentValidationGroupRelations | false | none | Document validation group included relations |
documentValidationGroupFindResponse
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"type": "or",
"action": "score",
"score": 2,
"sequence": 1,
"documentValidationSet": {
"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": "ID card validation",
"scoreToBeValid": 10,
"scoreToBePending": 1
}
}
]
Document validation group collection
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | documentValidationGroup | false | none | Document validation group properties |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | documentValidationGroupRelations | false | none | Document validation group included relations |
documentValidationGroupRelations
{
"documentValidationSet": {
"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": "ID card validation",
"scoreToBeValid": 10,
"scoreToBePending": 1
}
}
Document validation group included relations
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
documentValidationSet | documentValidationSet | false | none | Related validation set |
documentValidationGroupUpdate
[
{
"type": "or",
"action": "score",
"score": 2,
"sequence": 1,
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
Array of document validation groups to update
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
type | string | false | none | Validation group type. It defines how group should be validated based on the related rules validations. |
action | string | false | none | Validation group action. It defines what should to do immediately after validation this group with rules. |
score | number | false | none | The number of points that document receives when passing this group of rules. |
sequence | number | false | none | The sequence number to show validation groups in appropriate order |
id | UUID_V4 | false | none | Unique identifier for the entity |
Enumerated Values
Property | Value |
---|---|
type | or |
type | and |
action | score |
action | rejectedDocument |
action | validatedDocument |
action | pendingDocument |
documentValidationGroupUpdateById
{
"type": "or",
"action": "score",
"score": 2,
"sequence": 1
}
Update document validation group body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
type | string | false | none | Validation group type. It defines how group should be validated based on the related rules validations. |
action | string | false | none | Validation group action. It defines what should to do immediately after validation this group with rules. |
score | number | false | none | The number of points that document receives when passing this group of rules. |
sequence | number | false | none | The sequence number to show validation groups in appropriate order |
Enumerated Values
Property | Value |
---|---|
type | or |
type | and |
action | score |
action | rejectedDocument |
action | validatedDocument |
action | pendingDocument |
documentValidation
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string"
}
Document validation properties
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | object | false | none | none |
» id | UUID_V4 | true | none | Unique identifier for the entity |
» companyId | UUID_V4 | true | none | Unique identifier for the entity |
» documentValidationSetId | UUID_V4 | true | none | Unique identifier for the entity |
» documentValidationGroupId | UUID_V4 | true | none | Unique identifier for the entity |
» createdAt | DateISO | false | none | Datetime in ISO format |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | documentValidationBase | false | none | none |
documentValidationArray
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string"
}
]
Array of document validations
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [documentValidation] | false | none | Array of document validations |
documentValidationDelete
{
"ids": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}
Delete document validations body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
ids | [UUID_V4] | false | none | Array of document validation ids |
documentValidationCreate
[
{
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
Array of document validations to create
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [documentValidationCreateOne] | false | none | Array of document validations to create |
documentValidationCreateOne
{
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
Create document validation body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
fieldName | string | true | none | The name of the field in the parsing results |
sequence | number | false | none | The sequence number to show validation rules in appropriate order |
method | string | true | none | Validation method |
value | object | true | none | Value for verification. (Not required for method notEmpty) |
type | string | false | none | Validation type. It defines what should be expected field type. |
documentValidationSetId | UUID_V4 | true | none | Unique identifier for the entity |
documentValidationGroupId | UUID_V4 | true | none | Unique identifier for the entity |
Enumerated Values
Property | Value |
---|---|
method | empty |
method | equally |
method | contains |
method | inList |
method | notInList |
method | notEqual |
method | notEmpty |
method | notContains |
method | dateBetween |
method | dateBeforeFixed |
method | dateAfterFixed |
method | dateBeforePeriod |
method | dateAfterPeriod |
method | faceMatchSimilarityMore |
method | faceMatchSimilarityMoreOrEqual |
method | faceMatchSimilarityLess |
method | faceMatchSimilarityLessOrEqual |
type | string |
type | date |
type | number |
documentValidationBase
{
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
fieldName | string | false | none | The name of the field in the parsing results |
sequence | number | false | none | The sequence number to show validation rules in appropriate order |
method | string | false | none | Validation method |
value | object | false | none | Value for verification. (Not required for method notEmpty) |
type | string | false | none | Validation type. It defines what should be expected field type. |
Enumerated Values
Property | Value |
---|---|
method | empty |
method | equally |
method | contains |
method | inList |
method | notInList |
method | notEqual |
method | notEmpty |
method | notContains |
method | dateBetween |
method | dateBeforeFixed |
method | dateAfterFixed |
method | dateBeforePeriod |
method | dateAfterPeriod |
method | faceMatchSimilarityMore |
method | faceMatchSimilarityMoreOrEqual |
method | faceMatchSimilarityLess |
method | faceMatchSimilarityLessOrEqual |
type | string |
type | date |
type | number |
documentValidationUpdate
[
{
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string",
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
}
]
Array of document validations to update
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
fieldName | string | false | none | The name of the field in the parsing results |
sequence | number | false | none | The sequence number to show validation rules in appropriate order |
method | string | false | none | Validation method |
value | object | false | none | Value for verification. (Not required for method notEmpty) |
type | string | false | none | Validation type. It defines what should be expected field type. |
id | UUID_V4 | false | none | Unique identifier for the entity |
documentValidationSetId | UUID_V4 | false | none | Unique identifier for the entity |
documentValidationGroupId | UUID_V4 | false | none | Unique identifier for the entity |
Enumerated Values
Property | Value |
---|---|
method | empty |
method | equally |
method | contains |
method | inList |
method | notInList |
method | notEqual |
method | notEmpty |
method | notContains |
method | dateBetween |
method | dateBeforeFixed |
method | dateAfterFixed |
method | dateBeforePeriod |
method | dateAfterPeriod |
method | faceMatchSimilarityMore |
method | faceMatchSimilarityMoreOrEqual |
method | faceMatchSimilarityLess |
method | faceMatchSimilarityLessOrEqual |
type | string |
type | date |
type | number |
documentValidationFindResponse
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string",
"documentValidationSet": {
"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": "ID card validation",
"scoreToBeValid": 10,
"scoreToBePending": 1
},
"documentValidationGroup": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"type": "or",
"action": "score",
"score": 2,
"sequence": 1
}
}
]
Document validation collection
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | documentValidation | false | none | Document validation properties |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | documentValidationRelations | false | none | Document validation included relations |
documentValidationFindByIdResponse
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationGroupId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string",
"documentValidationSet": {
"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": "ID card validation",
"scoreToBeValid": 10,
"scoreToBePending": 1
},
"documentValidationGroup": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"type": "or",
"action": "score",
"score": 2,
"sequence": 1
}
}
Document validation with relations
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | documentValidation | false | none | Document validation properties |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | documentValidationRelations | false | none | Document validation included relations |
documentValidationRelations
{
"documentValidationSet": {
"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": "ID card validation",
"scoreToBeValid": 10,
"scoreToBePending": 1
},
"documentValidationGroup": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"type": "or",
"action": "score",
"score": 2,
"sequence": 1
}
}
Document validation included relations
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
documentValidationSet | documentValidationSet | false | none | Related validation set |
documentValidationGroup | documentValidationGroup | false | none | Related validation group |
documentValidationUpdateById
{
"fieldName": "firstName",
"sequence": 1,
"method": "contains",
"value": {
"value": "Elon"
},
"type": "string"
}
Update document validation body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
fieldName | string | false | none | The name of the field in the parsing results |
sequence | number | false | none | The sequence number to show validation rules in appropriate order |
method | string | false | none | Validation method |
value | object | false | none | Value for verification. (Not required for method notEmpty) |
type | string | false | none | Validation type. It defines what should be expected field type. |
Enumerated Values
Property | Value |
---|---|
method | empty |
method | equally |
method | contains |
method | inList |
method | notInList |
method | notEqual |
method | notEmpty |
method | notContains |
method | dateBetween |
method | dateBeforeFixed |
method | dateAfterFixed |
method | dateBeforePeriod |
method | dateAfterPeriod |
method | faceMatchSimilarityMore |
method | faceMatchSimilarityMoreOrEqual |
method | faceMatchSimilarityLess |
method | faceMatchSimilarityLessOrEqual |
type | string |
type | date |
type | number |
form
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Work Permit",
"reference": "work_permit",
"shareCode": "",
"type": "editable",
"language": "en",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"updatedById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Form properties
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | false | none | Unique identifier for the entity |
companyId | UUID_V4 | false | none | Unique identifier for the entity |
signatureId | UUID_V4 | false | none | Unique identifier for the entity |
name | string | false | none | Form name |
reference | string | false | none | Form reference |
shareCode | string | false | none | Form share code |
type | formType | false | none | One of Form type enumeration |
language | formLanguage | false | none | One of Form language enumeration |
actions | formActions | false | none | Form actions (at least one action required); Please note that allowable actions depend on the type of the original form:
|
isMandatory | boolean | false | none | Is Form mandatory |
isPreliminary | boolean | false | none | Is Form preliminary |
isBlocking | boolean | false | none | Is the candidate screen blocking by the form popup |
filename | string | false | none | Form filename |
createdById | UUID_V4 | false | none | Unique identifier for the entity |
updatedById | UUID_V4 | false | none | Unique identifier for the entity |
createdAt | DateISO | false | none | Datetime in ISO format |
updatedAt | DateISO | false | none | Datetime in ISO format |
formBase
{
"name": "Work Permit",
"reference": "work_permit",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"filename": "initial_{candidateFirstname}",
"language": "en",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"isPdfGenerationEnabled": false
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
name | string | false | none | Form name |
reference | string | false | none | Form reference |
signatureId | UUID_V4 | false | none | Unique identifier for the entity |
additionId | UUID_V4 | false | none | Unique identifier for the entity |
fileId | UUID_V4 | false | none | Unique identifier for the entity |
filename | string | false | none | Form file name |
language | formLanguage | false | none | One of Form language enumeration |
actions | formActions | false | none | Form actions (at least one action required); Please note that allowable actions depend on the type of the original form:
|
isMandatory | boolean | false | none | Is Form mandatory |
isPreliminary | boolean | false | none | Is Form preliminary |
isBlocking | boolean | false | none | Is the candidate screen blocking by the form popup |
isPdfGenerationEnabled | boolean | false | none | Is Form PDF generation enabled |
formFindResponse
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Work Permit",
"reference": "work_permit",
"shareCode": "",
"type": "editable",
"language": "en",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"updatedById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"createdBy": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"lastActivityAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"isOwner": false
},
"updatedBy": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"lastActivityAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"isOwner": false
},
"addition": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"sequence": 1,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
}
]
Form Collection
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | false | none | Unique identifier for the entity |
companyId | UUID_V4 | false | none | Unique identifier for the entity |
signatureId | UUID_V4 | false | none | Unique identifier for the entity |
name | string | false | none | Form name |
reference | string | false | none | Form reference |
shareCode | string | false | none | Form share code |
type | formType | false | none | One of Form type enumeration |
language | formLanguage | false | none | One of Form language enumeration |
actions | formActions | false | none | Form actions (at least one action required); Please note that allowable actions depend on the type of the original form:
|
isMandatory | boolean | false | none | Is Form mandatory |
isPreliminary | boolean | false | none | Is Form preliminary |
isBlocking | boolean | false | none | Is the candidate screen blocking by the form popup |
filename | string | false | none | Form filename |
createdById | UUID_V4 | false | none | Unique identifier for the entity |
updatedById | UUID_V4 | false | none | Unique identifier for the entity |
createdAt | DateISO | false | none | Datetime in ISO format |
updatedAt | DateISO | false | none | Datetime in ISO format |
createdBy | adminUser | false | none | Related admin user who created the form |
updatedBy | adminUser | false | none | Related admin user who updated the form |
addition | formAddition | false | none | Related form addition |
formFindByIdResponse
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Work Permit",
"reference": "work_permit",
"shareCode": "",
"type": "editable",
"language": "en",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"updatedById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"createdBy": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"lastActivityAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"isOwner": false
},
"updatedBy": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyTokenId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"lastActivityAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"gender": "female",
"firstName": "James",
"lastName": "Good",
"email": "[email protected]",
"phone": "+32 0x xxx xx xx",
"position": "Manager",
"language": "en",
"forceChangePassword": false,
"isOwner": false
},
"addition": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"sequence": 1,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
}
Form properties
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | false | none | Unique identifier for the entity |
companyId | UUID_V4 | false | none | Unique identifier for the entity |
signatureId | UUID_V4 | false | none | Unique identifier for the entity |
name | string | false | none | Form name |
reference | string | false | none | Form reference |
shareCode | string | false | none | Form share code |
type | formType | false | none | One of Form type enumeration |
language | formLanguage | false | none | One of Form language enumeration |
actions | formActions | false | none | Form actions (at least one action required); Please note that allowable actions depend on the type of the original form:
|
isMandatory | boolean | false | none | Is Form mandatory |
isPreliminary | boolean | false | none | Is Form preliminary |
isBlocking | boolean | false | none | Is the candidate screen blocking by the form popup |
filename | string | false | none | Form filename |
createdById | UUID_V4 | false | none | Unique identifier for the entity |
updatedById | UUID_V4 | false | none | Unique identifier for the entity |
createdAt | DateISO | false | none | Datetime in ISO format |
updatedAt | DateISO | false | none | Datetime in ISO format |
createdBy | adminUser | false | none | Related admin user who created the form |
updatedBy | adminUser | false | none | Related admin user who updated the form |
addition | formAddition | false | none | Related form addition |
formType
"editable"
One of Form type enumeration
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | One of Form type enumeration |
Enumerated Values
Property | Value |
---|---|
anonymous | readonly |
anonymous | editable |
anonymous | file |
anonymous | combo |
formLanguage
"en"
One of Form language enumeration
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | One of Form language enumeration |
Enumerated Values
Property | Value |
---|---|
anonymous | en |
anonymous | fr |
anonymous | nl |
anonymous | de |
anonymous | it |
anonymous | pl |
anonymous | ro |
anonymous | sq |
anonymous | be |
anonymous | bg |
anonymous | hr |
anonymous | cs |
anonymous | da |
anonymous | et |
anonymous | fi |
anonymous | el |
anonymous | hu |
anonymous | is |
anonymous | ga |
anonymous | lv |
anonymous | lt |
anonymous | mk |
anonymous | mt |
anonymous | no |
anonymous | pt |
anonymous | ru |
anonymous | sr |
anonymous | sk |
anonymous | sl |
anonymous | es |
anonymous | sv |
anonymous | uk |
anonymous | cy |
formAction
"read"
An action that a candidate must perform with a form
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | An action that a candidate must perform with a form |
Enumerated Values
Property | Value |
---|---|
anonymous | read |
anonymous | complete |
anonymous | eSign |
anonymous | download |
formActions
[
"complete",
"download"
]
Form actions (at least one action required);
Please note that allowable actions depend on the type of the original form:
file
, readonly
and combo
types: read
, eSign
, download
editable
type: complete
, eSign
, download
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [formAction] | false | none | Form actions (at least one action required); Please note that allowable actions depend on the type of the original form:
|
formArray
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Work Permit",
"reference": "work_permit",
"shareCode": "",
"type": "editable",
"language": "en",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"updatedById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
Array of forms
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [form] | false | none | Array of forms |
formShareResponse
{
"shareCode": "AK9300BC"
}
Share code which can be used to import form to any company
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
shareCode | string | false | none | none |
formSuccessResponse
{
"success": true
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
success | boolean | false | none | none |
formContent
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"content": {},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Form content properties
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | true | none | Unique identifier for the entity |
formId | UUID_V4 | true | none | Unique identifier for the entity |
content | object | true | none | Form content |
createdAt | DateISO | true | none | Datetime in ISO format |
updatedAt | DateISO | true | none | Datetime in ISO format |
formContentUpdateByIdBody
{
"content": {}
}
Update form content body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
content | object | true | none | Form content |
formAddition
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"additionId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"sequence": 1,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Form addition properties
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | true | none | Unique identifier for the entity |
companyId | UUID_V4 | false | none | Unique identifier for the entity |
formId | UUID_V4 | true | none | Unique identifier for the entity |
additionId | UUID_V4 | true | none | Related Addition Form |
sequence | number | false | none | The sequence number to show additions in appropriate order |
createdAt | DateISO | true | none | Datetime in ISO format |
updatedAt | DateISO | true | none | Datetime in ISO format |
fileContentType
"image/jpeg"
Visible column.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | Visible column. |
Enumerated Values
Property | Value |
---|---|
anonymous | image/jpeg |
anonymous | image/png |
anonymous | image/gif |
anonymous | image/bmp |
anonymous | text/plain |
anonymous | application/pdf |
anonymous | application/msword |
anonymous | application/vnd.openxmlformats-officedocument.wordprocessingml.document |
anonymous | application/vnd.ms-excel |
anonymous | application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
anonymous | application/vnd.ms-powerpoint |
anonymous | application/vnd.openxmlformats-officedocument.presentationml.presentation |
anonymous | application/vnd.oasis.opendocument.text |
anonymous | application/vnd.oasis.opendocument.spreadsheet |
anonymous | application/vnd.oasis.opendocument.presentation |
anonymous | text/csv |
anonymous | application/zip |
anonymous | application/x-tar |
anonymous | application/gzip |
anonymous | audio/mpeg |
anonymous | video/mp4 |
anonymous | video/x-ms-wmv |
anonymous | video/quicktime |
anonymous | image/svg+xml |
anonymous | image/tiff |
anonymous | image/vnd.microsoft.icon |
anonymous | application/rtf |
anonymous | application/json |
anonymous | text/markdown |
anonymous | video/webm |
anonymous | application/ogg |
anonymous | video/ogg |
anonymous | audio/flac |
anonymous | audio/wav |
anonymous | video/x-msvideo |
anonymous | video/x-matroska |
anonymous | text/yaml |
anonymous | text/calendar |
anonymous | text/x-vcalendar |
fileStorage
"internal"
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | none |
Enumerated Values
Property | Value |
---|---|
anonymous | internal |
fileBase
{
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
companyId | UUID_V4 | false | none | Unique identifier for the entity |
checksum | string | false | none | File checksum |
name | string | false | none | File name |
ext | string | false | none | File extension |
type | string | false | none | File type |
size | string | false | none | File size |
storage | fileStorage | false | none | none |
key | string | false | none | File key |
url | string | false | none | File url |
isPublic | boolean | false | none | Is public file |
file
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
}
File
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | object | false | none | none |
» id | UUID_V4 | false | none | Unique identifier for the entity |
» createdAt | DateISO | false | none | Datetime in ISO format |
» updatedAt | DateISO | false | none | Datetime in ISO format |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | fileBase | false | none | none |
fileUpload
{
"file": "There should be your file in binary format",
"isPublic": false,
"storage": "internal"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
file | string(binary) | true | none | File to be uploaded. It should have allowed content type |
isPublic | boolean | false | none | Is public file |
storage | fileStorage | false | none | none |
fileRelations
{}
File included relations
Properties
None
fileFindResponse
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
}
]
File Collection
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | file | false | none | File |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | fileRelations | false | none | File included relations |
fileFindByIdResponse
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"checksum": "File checksum",
"name": "File name",
"ext": ".jpeg",
"type": "image/jpeg",
"size": "image/jpeg",
"storage": "internal",
"key": "",
"url": "",
"isPublic": false
}
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | file | false | none | File |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | fileRelations | false | none | File included relations |
integration
{
"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",
"isAllAccounts": false,
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllForms": false,
"forms": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"name": "string",
"triggerEvent": "candidateCompleted",
"type": "push",
"isActive": false,
"connectionData": {
"url": "string",
"headers": {}
}
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | false | none | Unique identifier for the entity |
companyId | UUID_V4 | false | none | Unique identifier for the entity |
createdAt | DateISO | false | none | Datetime in ISO format |
updatedAt | DateISO | false | none | Datetime in ISO format |
isAllAccounts | boolean | true | none | Integration will be assigned to all company accounts. |
accounts | integrationAccounts | false | none | Array of related accounts. |
isAllForms | boolean | false | none | Form related integration will be assigned to all company forms. |
forms | integrationForms | false | none | Forms array of form related integrations. |
name | string | true | none | Integration name |
triggerEvent | integrationTriggerEvent | true | none | Integration trigger event |
type | integrationType | true | none | Integration type |
isActive | boolean | true | none | Integration will be active or inactive. |
connectionData | object | false | none | Integration connection data. |
» url | string | false | none | POST data will be send to external url address. For example - 'https://c713.m.example.net' |
» headers | object | false | none | Integration connection data headers |
integrationAccounts
[
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
Array of related accounts.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [UUID_V4] | false | none | Array of related accounts. |
integrationForms
[
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
Forms array of form related integrations.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [UUID_V4] | false | none | Forms array of form related integrations. |
integrationTriggerEvent
"candidateCompleted"
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | none |
Enumerated Values
Property | Value |
---|---|
anonymous | formCompleted |
anonymous | formSigned |
anonymous | resourceCompleted |
anonymous | daasFileParsed |
anonymous | candidateUploadedFile |
anonymous | candidateUploadedFileRejected |
anonymous | candidateUploadedFileValidated |
anonymous | candidateCreated |
anonymous | candidateUpdated |
anonymous | candidateCompleted |
anonymous | candidateDeleted |
integrationType
"push"
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | none |
Enumerated Values
Property | Value |
---|---|
anonymous | zapier |
anonymous | push |
integrationConnectionData
{
"url": "string",
"headers": {}
}
Integration connection data.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
url | string | false | none | POST data will be send to external url address. For example - 'https://c713.m.example.net' |
headers | object | false | none | Integration connection data headers |
integrationFindResponse
[
{
"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",
"isAllAccounts": false,
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"isAllForms": false,
"forms": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"name": "string",
"triggerEvent": "candidateCompleted",
"type": "push",
"isActive": false,
"connectionData": {
"url": "string",
"headers": {}
}
}
]
Integration Collection
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [integration] | false | none | Integration Collection |
integrationLogsFindResponse
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"author": "string",
"description": "string",
"type": "string",
"status": "string",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"name": "Welcome letter",
"templateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"reference": "WELCOME_EN_DE_CREATED",
"delayInHours": 0,
"eventName": "candidateCreated",
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"languages": [
"en",
"fr",
"nl"
],
"recipients": {
"candidate": {
"enabled": true
},
"creator": {
"enabled": true
},
"customEmail": {
"enabled": true,
"email": "[email protected]"
},
"customFields": {
"enabled": true,
"fieldIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}
},
"replyTo": {
"type": "default",
"value": "[email protected]"
},
"isActive": true,
"tagsCondition": "or"
}
]
Integration log Collection
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [log] | false | none | Integration log Collection |
integrationLogsCountResponse
{
"total": 0
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
total | number | false | none | Total of counted integration logs |
integrationSendInitRequestResponse
{
"info": "",
"success": true
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
info | string | false | none | none |
success | boolean | false | none | none |
integrationExamplesData
{
"candidateName": "string",
"candidateFirstName": "string",
"candidateLastName": "string",
"candidateReference": "string",
"candidateLanguage": "string",
"candidatePreferredLanguage": "string",
"candidateEmail": "string",
"additionalEmails": [
"[email protected]"
],
"candidateStatus": "pending",
"candidateMobilePhone": "string",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateCreatedAt": "2019-09-12T15:36:09.264Z",
"candidateUpdatedAt": "2019-09-12T15:36:09.264Z",
"candidateDeadline": "2019-09-12T15:36:09.264Z",
"candidateInternalNotes": "string",
"candidateTagIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"candidateTagNames": [
"import",
"office",
"VIP"
],
"candidateAssigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountName": "string",
"accountReference": "string",
"candidateCustomFields": {}
}
Properties
oneOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | integrationExampleCandidateCompletedData | false | none | Example data of the 'candidateCompleted' trigger event |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | integrationExampleCandidateCreatedData | false | none | Example data of the 'candidateCreated' trigger event |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | integrationExampleCandidateUpdatedData | false | none | Example data of the 'candidateUpdated' trigger event |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | integrationExampleCandidateDeletedData | false | none | Example data of the 'candidateDeleted' trigger event |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | integrationExampleCandidateUploadedFileData | false | none | Example data of the 'candidateUploadedFile' trigger event |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | integrationExampleCandidateUploadedFileRejectedData | false | none | Example data of the 'candidateUploadedFileRejected' trigger event |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | integrationExampleCandidateUploadedFileValidatedData | false | none | Example data of the 'candidateUploadedFileRejected' trigger event |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | integrationExampleResourceCompletedData | false | none | Example data of the 'resourceCompleted' trigger event |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | integrationExampleFormCompletedData | false | none | Example data of the 'formCompleted' trigger event |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | integrationExampleFormSignedData | false | none | Example data of the 'formSigned' trigger event |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | integrationExampleDaasFileParsedData | false | none | Example data of the 'daasFileParsed' trigger event |
integrationExampleCandidateCompletedData
{
"candidateName": "string",
"candidateFirstName": "string",
"candidateLastName": "string",
"candidateReference": "string",
"candidateLanguage": "string",
"candidatePreferredLanguage": "string",
"candidateEmail": "string",
"additionalEmails": [
"[email protected]"
],
"candidateStatus": "pending",
"candidateMobilePhone": "string",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateCreatedAt": "2019-09-12T15:36:09.264Z",
"candidateUpdatedAt": "2019-09-12T15:36:09.264Z",
"candidateDeadline": "2019-09-12T15:36:09.264Z",
"candidateInternalNotes": "string",
"candidateTagIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"candidateTagNames": [
"import",
"office",
"VIP"
],
"candidateAssigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountName": "string",
"accountReference": "string",
"candidateCustomFields": {}
}
Example data of the 'candidateCompleted' trigger event
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
candidateName | string | false | none | Candidate name which consist of firstName and lastName |
candidateFirstName | string | false | none | Candidate firstName |
candidateLastName | string | false | none | Candidate lastName |
candidateReference | string | false | none | Candidate reference |
candidateLanguage | string | false | none | Candidate language |
candidatePreferredLanguage | string | false | none | Candidate preferred language |
candidateEmail | string | false | none | Candidate email |
additionalEmails | candidateAdditionalEmails | false | none | Candidate additional emails |
candidateStatus | candidateStatus | false | none | Candidate status |
candidateMobilePhone | string | false | none | Candidate mobile phone number |
candidateId | UUID_V4 | false | none | Candidate id |
candidateCreatedAt | DateISO | false | none | Candidate createdAt date |
candidateUpdatedAt | DateISO | false | none | Candidate updatedAt date |
candidateDeadline | DateISO | false | none | Candidate deadline date |
candidateInternalNotes | string | false | none | Candidate notes |
candidateTagIds | [UUID_V4] | false | none | Candidate tag ids |
candidateTagNames | [string] | false | none | Candidate tag names |
candidateAssigneeId | UUID_V4 | false | none | Candidate Assignee id |
accountId | UUID_V4 | false | none | Account id |
accountName | string | false | none | Account name |
accountReference | string | false | none | Account reference |
candidateCustomFields | object | false | none | none |
integrationExampleCandidateCreatedData
{
"candidateName": "string",
"candidateFirstName": "string",
"candidateLastName": "string",
"candidateReference": "string",
"candidateLanguage": "string",
"candidatePreferredLanguage": "string",
"candidateEmail": "string",
"additionalEmails": [
"[email protected]"
],
"candidateStatus": "pending",
"candidateMobilePhone": "string",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateCreatedAt": "2019-09-12T15:36:09.264Z",
"candidateUpdatedAt": "2019-09-12T15:36:09.264Z",
"candidateDeadline": "2019-09-12T15:36:09.264Z",
"candidateInternalNotes": "string",
"candidateTagIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"candidateTagNames": [
"import",
"office",
"VIP"
],
"candidateAssigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountName": "string",
"accountReference": "string",
"candidateCustomFields": {}
}
Example data of the 'candidateCreated' trigger event
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
candidateName | string | false | none | Candidate name which consist of firstName and lastName |
candidateFirstName | string | false | none | Candidate firstName |
candidateLastName | string | false | none | Candidate lastName |
candidateReference | string | false | none | Candidate reference |
candidateLanguage | string | false | none | Candidate language |
candidatePreferredLanguage | string | false | none | Candidate preferred language |
candidateEmail | string | false | none | Candidate email |
additionalEmails | candidateAdditionalEmails | false | none | Candidate additional emails |
candidateStatus | candidateStatus | false | none | Candidate status |
candidateMobilePhone | string | false | none | Candidate mobile phone number |
candidateId | UUID_V4 | false | none | Candidate id |
candidateCreatedAt | DateISO | false | none | Candidate createdAt date |
candidateUpdatedAt | DateISO | false | none | Candidate updatedAt date |
candidateDeadline | DateISO | false | none | Candidate deadline date |
candidateInternalNotes | string | false | none | Candidate notes |
candidateTagIds | [UUID_V4] | false | none | Candidate tag ids |
candidateTagNames | [string] | false | none | Candidate tag names |
candidateAssigneeId | UUID_V4 | false | none | Candidate Assignee id |
accountId | UUID_V4 | false | none | Account id |
accountName | string | false | none | Account name |
accountReference | string | false | none | Account reference |
candidateCustomFields | object | false | none | none |
integrationExampleCandidateUpdatedData
{
"candidateName": "string",
"candidateFirstName": "string",
"candidateLastName": "string",
"candidateReference": "string",
"candidateLanguage": "string",
"candidatePreferredLanguage": "string",
"candidateEmail": "string",
"additionalEmails": [
"[email protected]"
],
"candidateStatus": "pending",
"candidateMobilePhone": "string",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateCreatedAt": "2019-09-12T15:36:09.264Z",
"candidateUpdatedAt": "2019-09-12T15:36:09.264Z",
"candidateDeadline": "2019-09-12T15:36:09.264Z",
"candidateInternalNotes": "string",
"candidateTagIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"candidateTagNames": [
"import",
"office",
"VIP"
],
"candidateAssigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountName": "string",
"accountReference": "string",
"candidateCustomFields": {}
}
Example data of the 'candidateUpdated' trigger event
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
candidateName | string | false | none | Candidate name which consist of firstName and lastName |
candidateFirstName | string | false | none | Candidate firstName |
candidateLastName | string | false | none | Candidate lastName |
candidateReference | string | false | none | Candidate reference |
candidateLanguage | string | false | none | Candidate language |
candidatePreferredLanguage | string | false | none | Candidate preferred language |
candidateEmail | string | false | none | Candidate email |
additionalEmails | candidateAdditionalEmails | false | none | Candidate additional emails |
candidateStatus | candidateStatus | false | none | Candidate status |
candidateMobilePhone | string | false | none | Candidate mobile phone number |
candidateId | UUID_V4 | false | none | Candidate id |
candidateCreatedAt | DateISO | false | none | Candidate createdAt date |
candidateUpdatedAt | DateISO | false | none | Candidate updatedAt date |
candidateDeadline | DateISO | false | none | Candidate deadline date |
candidateInternalNotes | string | false | none | Candidate notes |
candidateTagIds | [UUID_V4] | false | none | Candidate tag ids |
candidateTagNames | [string] | false | none | Candidate tag names |
candidateAssigneeId | UUID_V4 | false | none | Candidate Assignee id |
accountId | UUID_V4 | false | none | Account id |
accountName | string | false | none | Account name |
accountReference | string | false | none | Account reference |
candidateCustomFields | object | false | none | none |
integrationExampleCandidateUploadedFileData
{
"candidateName": "string",
"candidateFirstName": "string",
"candidateLastName": "string",
"candidateReference": "string",
"candidateLanguage": "string",
"candidatePreferredLanguage": "string",
"candidateEmail": "string",
"additionalEmails": [
"[email protected]"
],
"candidateStatus": "pending",
"candidateMobilePhone": "string",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateCreatedAt": "2019-09-12T15:36:09.264Z",
"candidateUpdatedAt": "2019-09-12T15:36:09.264Z",
"candidateDeadline": "2019-09-12T15:36:09.264Z",
"candidateInternalNotes": "string",
"candidateTagIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"candidateTagNames": [
"import",
"office",
"VIP"
],
"candidateAssigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountName": "string",
"accountReference": "string",
"candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateDocumentTypeIsMultiple": true,
"candidateDocumentTypeStatus": "300",
"candidateDocumentIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"documentTypeName": "string",
"documentTypeReference": "string",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isValidDocument": true,
"isManualValidationRequired": true,
"documentSize": 0,
"documentMimeType": "string",
"documentCustomFields": {},
"candidateDocumentTypeFaceMatch": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"similarity": 0.999332,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"candidateDocumentTypeImages": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"type": "portrait",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
}
Example data of the 'candidateUploadedFile' trigger event
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
candidateName | string | false | none | Candidate name which consist of firstName and lastName |
candidateFirstName | string | false | none | Candidate firstName |
candidateLastName | string | false | none | Candidate lastName |
candidateReference | string | false | none | Candidate reference |
candidateLanguage | string | false | none | Candidate language |
candidatePreferredLanguage | string | false | none | Candidate preferred language |
candidateEmail | string | false | none | Candidate email |
additionalEmails | candidateAdditionalEmails | false | none | Candidate additional emails |
candidateStatus | candidateStatus | false | none | Candidate status |
candidateMobilePhone | string | false | none | Candidate mobile phone number |
candidateId | UUID_V4 | false | none | Candidate id |
candidateCreatedAt | DateISO | false | none | Candidate createdAt date |
candidateUpdatedAt | DateISO | false | none | Candidate updatedAt date |
candidateDeadline | DateISO | false | none | Candidate deadline date |
candidateInternalNotes | string | false | none | Candidate notes |
candidateTagIds | [UUID_V4] | false | none | Candidate tag ids |
candidateTagNames | [string] | false | none | Candidate tag names |
candidateAssigneeId | UUID_V4 | false | none | Candidate Assignee id |
accountId | UUID_V4 | false | none | Account id |
accountName | string | false | none | Account name |
accountReference | string | false | none | Account reference |
candidateDocumentTypeId | UUID_V4 | false | none | Candidate document type id |
candidateDocumentTypeIsMultiple | boolean | false | none | Is candidate document type contains more than one candidate document |
candidateDocumentTypeStatus | string | false | none | none |
candidateDocumentIds | [UUID_V4] | false | none | Candidate document ids in this candidate document type |
documentTypeName | string | false | none | Document type name |
documentTypeReference | string | false | none | Document type reference |
documentTypeId | UUID_V4 | false | none | Document type id |
isValidDocument | boolean | false | none | Is valid Candidate document type status |
isManualValidationRequired | boolean | false | none | Is manual validation Candidate document type status |
documentSize | number | false | none | none |
documentMimeType | string | false | none | Candidate document content type |
documentCustomFields | object | false | none | none |
candidateDocumentTypeFaceMatch | candidateDocumentTypeFaceMatch | false | none | Candidate document type face match data |
candidateDocumentTypeImages | [candidateDocumentTypeImage] | false | none | Candidate document type images data |
Enumerated Values
Property | Value |
---|---|
candidateDocumentTypeStatus | 300 |
candidateDocumentTypeStatus | 400 |
candidateDocumentTypeStatus | 402 |
candidateDocumentTypeStatus | 403 |
integrationExampleCandidateUploadedFileRejectedData
{
"candidateName": "string",
"candidateFirstName": "string",
"candidateLastName": "string",
"candidateReference": "string",
"candidateLanguage": "string",
"candidatePreferredLanguage": "string",
"candidateEmail": "string",
"additionalEmails": [
"[email protected]"
],
"candidateStatus": "pending",
"candidateMobilePhone": "string",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateCreatedAt": "2019-09-12T15:36:09.264Z",
"candidateUpdatedAt": "2019-09-12T15:36:09.264Z",
"candidateDeadline": "2019-09-12T15:36:09.264Z",
"candidateInternalNotes": "string",
"candidateTagIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"candidateTagNames": [
"import",
"office",
"VIP"
],
"candidateAssigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountName": "string",
"accountReference": "string",
"candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateDocumentTypeIsMultiple": true,
"candidateDocumentTypeStatus": "900",
"candidateDocumentIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"documentTypeName": "string",
"documentTypeReference": "string",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isValidDocument": true,
"isManualValidationRequired": true,
"documentSize": 0,
"documentMimeType": "string",
"documentCustomFields": {},
"candidateDocumentTypeFaceMatch": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"similarity": 0.999332,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"candidateDocumentTypeImages": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"type": "portrait",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
}
Example data of the 'candidateUploadedFileRejected' trigger event
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
candidateName | string | false | none | Candidate name which consist of firstName and lastName |
candidateFirstName | string | false | none | Candidate firstName |
candidateLastName | string | false | none | Candidate lastName |
candidateReference | string | false | none | Candidate reference |
candidateLanguage | string | false | none | Candidate language |
candidatePreferredLanguage | string | false | none | Candidate preferred language |
candidateEmail | string | false | none | Candidate email |
additionalEmails | candidateAdditionalEmails | false | none | Candidate additional emails |
candidateStatus | candidateStatus | false | none | Candidate status |
candidateMobilePhone | string | false | none | Candidate mobile phone number |
candidateId | UUID_V4 | false | none | Candidate id |
candidateCreatedAt | DateISO | false | none | Candidate createdAt date |
candidateUpdatedAt | DateISO | false | none | Candidate updatedAt date |
candidateDeadline | DateISO | false | none | Candidate deadline date |
candidateInternalNotes | string | false | none | Candidate notes |
candidateTagIds | [UUID_V4] | false | none | Candidate tag ids |
candidateTagNames | [string] | false | none | Candidate tag names |
candidateAssigneeId | UUID_V4 | false | none | Candidate Assignee id |
accountId | UUID_V4 | false | none | Account id |
accountName | string | false | none | Account name |
accountReference | string | false | none | Account reference |
candidateDocumentTypeId | UUID_V4 | false | none | Candidate document type id |
candidateDocumentTypeIsMultiple | boolean | false | none | Is candidate document type contains more than one candidate document |
candidateDocumentTypeStatus | string | false | none | none |
candidateDocumentIds | [UUID_V4] | false | none | Candidate document ids in this candidate document type |
documentTypeName | string | false | none | Document type name |
documentTypeReference | string | false | none | Document type reference |
documentTypeId | UUID_V4 | false | none | Document type id |
isValidDocument | boolean | false | none | Is valid Candidate document type status |
isManualValidationRequired | boolean | false | none | Is manual validation Candidate document type status |
documentSize | number | false | none | none |
documentMimeType | string | false | none | Candidate document content type |
documentCustomFields | object | false | none | none |
candidateDocumentTypeFaceMatch | candidateDocumentTypeFaceMatch | false | none | Candidate document type face match data |
candidateDocumentTypeImages | [candidateDocumentTypeImage] | false | none | Candidate document type images data |
Enumerated Values
Property | Value |
---|---|
candidateDocumentTypeStatus | 900 |
candidateDocumentTypeStatus | 901 |
candidateDocumentTypeStatus | 905 |
integrationExampleCandidateUploadedFileValidatedData
{
"candidateName": "string",
"candidateFirstName": "string",
"candidateLastName": "string",
"candidateReference": "string",
"candidateLanguage": "string",
"candidatePreferredLanguage": "string",
"candidateEmail": "string",
"additionalEmails": [
"[email protected]"
],
"candidateStatus": "pending",
"candidateMobilePhone": "string",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateCreatedAt": "2019-09-12T15:36:09.264Z",
"candidateUpdatedAt": "2019-09-12T15:36:09.264Z",
"candidateDeadline": "2019-09-12T15:36:09.264Z",
"candidateInternalNotes": "string",
"candidateTagIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"candidateTagNames": [
"import",
"office",
"VIP"
],
"candidateAssigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountName": "string",
"accountReference": "string",
"candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateDocumentTypeIsMultiple": true,
"candidateDocumentTypeStatus": "400",
"candidateDocumentIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"documentTypeName": "string",
"documentTypeReference": "string",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isValidDocument": true,
"isManualValidationRequired": true,
"documentSize": 0,
"documentMimeType": "string",
"documentCustomFields": {},
"candidateDocumentTypeFaceMatch": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"similarity": 0.999332,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"candidateDocumentTypeImages": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateDocumentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"type": "portrait",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
}
Example data of the 'candidateUploadedFileRejected' trigger event
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
candidateName | string | false | none | Candidate name which consist of firstName and lastName |
candidateFirstName | string | false | none | Candidate firstName |
candidateLastName | string | false | none | Candidate lastName |
candidateReference | string | false | none | Candidate reference |
candidateLanguage | string | false | none | Candidate language |
candidatePreferredLanguage | string | false | none | Candidate preferred language |
candidateEmail | string | false | none | Candidate email |
additionalEmails | candidateAdditionalEmails | false | none | Candidate additional emails |
candidateStatus | candidateStatus | false | none | Candidate status |
candidateMobilePhone | string | false | none | Candidate mobile phone number |
candidateId | UUID_V4 | false | none | Candidate id |
candidateCreatedAt | DateISO | false | none | Candidate createdAt date |
candidateUpdatedAt | DateISO | false | none | Candidate updatedAt date |
candidateDeadline | DateISO | false | none | Candidate deadline date |
candidateInternalNotes | string | false | none | Candidate notes |
candidateTagIds | [UUID_V4] | false | none | Candidate tag ids |
candidateTagNames | [string] | false | none | Candidate tag names |
candidateAssigneeId | UUID_V4 | false | none | Candidate Assignee id |
accountId | UUID_V4 | false | none | Account id |
accountName | string | false | none | Account name |
accountReference | string | false | none | Account reference |
candidateDocumentTypeId | UUID_V4 | false | none | Candidate document type id |
candidateDocumentTypeIsMultiple | boolean | false | none | Is candidate document type contains more than one candidate document |
candidateDocumentTypeStatus | string | false | none | none |
candidateDocumentIds | [UUID_V4] | false | none | Candidate document ids in this candidate document type |
documentTypeName | string | false | none | Document type name |
documentTypeReference | string | false | none | Document type reference |
documentTypeId | UUID_V4 | false | none | Document type id |
isValidDocument | boolean | false | none | Is valid Candidate document type status |
isManualValidationRequired | boolean | false | none | Is manual validation Candidate document type status |
documentSize | number | false | none | none |
documentMimeType | string | false | none | Candidate document content type |
documentCustomFields | object | false | none | none |
candidateDocumentTypeFaceMatch | candidateDocumentTypeFaceMatch | false | none | Candidate document type face match data |
candidateDocumentTypeImages | [candidateDocumentTypeImage] | false | none | Candidate document type images data |
Enumerated Values
Property | Value |
---|---|
candidateDocumentTypeStatus | 400 |
candidateDocumentTypeStatus | 402 |
candidateDocumentTypeStatus | 403 |
integrationExampleResourceCompletedData
{
"candidateName": "string",
"candidateFirstName": "string",
"candidateLastName": "string",
"candidateReference": "string",
"candidateLanguage": "string",
"candidatePreferredLanguage": "string",
"candidateEmail": "string",
"additionalEmails": [
"[email protected]"
],
"candidateStatus": "pending",
"candidateMobilePhone": "string",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateCreatedAt": "2019-09-12T15:36:09.264Z",
"candidateUpdatedAt": "2019-09-12T15:36:09.264Z",
"candidateDeadline": "2019-09-12T15:36:09.264Z",
"candidateInternalNotes": "string",
"candidateTagIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"candidateTagNames": [
"import",
"office",
"VIP"
],
"candidateAssigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountName": "string",
"accountReference": "string",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateCustomFields": {},
"originalResourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceName": "string",
"resourceFields": {}
}
Example data of the 'resourceCompleted' trigger event
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
candidateName | string | false | none | Candidate name which consist of firstName and lastName |
candidateFirstName | string | false | none | Candidate firstName |
candidateLastName | string | false | none | Candidate lastName |
candidateReference | string | false | none | Candidate reference |
candidateLanguage | string | false | none | Candidate language |
candidatePreferredLanguage | string | false | none | Candidate preferred language |
candidateEmail | string | false | none | Candidate email |
additionalEmails | candidateAdditionalEmails | false | none | Candidate additional emails |
candidateStatus | candidateStatus | false | none | Candidate status |
candidateMobilePhone | string | false | none | Candidate mobile phone number |
candidateId | UUID_V4 | false | none | Candidate id |
candidateCreatedAt | DateISO | false | none | Candidate createdAt date |
candidateUpdatedAt | DateISO | false | none | Candidate updatedAt date |
candidateDeadline | DateISO | false | none | Candidate deadline date |
candidateInternalNotes | string | false | none | Candidate notes |
candidateTagIds | [UUID_V4] | false | none | Candidate tag ids |
candidateTagNames | [string] | false | none | Candidate tag names |
candidateAssigneeId | UUID_V4 | false | none | Candidate Assignee id |
accountId | UUID_V4 | false | none | Account id |
accountName | string | false | none | Account name |
accountReference | string | false | none | Account reference |
companyId | UUID_V4 | false | none | Company id |
candidateCustomFields | object | false | none | none |
originalResourceId | UUID_V4 | false | none | Resource id |
resourceId | UUID_V4 | false | none | Candidate resource id |
resourceName | string | false | none | Candidate resource name |
resourceFields | object | false | none | none |
integrationExampleFormCompletedData
{
"candidateName": "string",
"candidateFirstName": "string",
"candidateLastName": "string",
"candidateReference": "string",
"candidateLanguage": "string",
"candidatePreferredLanguage": "string",
"candidateEmail": "string",
"additionalEmails": [
"[email protected]"
],
"candidateStatus": "pending",
"candidateMobilePhone": "string",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateCreatedAt": "2019-09-12T15:36:09.264Z",
"candidateUpdatedAt": "2019-09-12T15:36:09.264Z",
"candidateDeadline": "2019-09-12T15:36:09.264Z",
"candidateInternalNotes": "string",
"candidateTagIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"candidateTagNames": [
"import",
"office",
"VIP"
],
"candidateAssigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountName": "string",
"accountReference": "string",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateCustomFields": {},
"originalFormId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formName": "string",
"formReference": "string",
"formFolder": "Registration",
"formCompletedAt": "2019-09-12T15:36:09.264Z",
"formDynamicFields": {},
"formContext": {},
"formMetadata": {}
}
Example data of the 'formCompleted' trigger event
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
candidateName | string | false | none | Candidate name which consist of firstName and lastName |
candidateFirstName | string | false | none | Candidate firstName |
candidateLastName | string | false | none | Candidate lastName |
candidateReference | string | false | none | Candidate reference |
candidateLanguage | string | false | none | Candidate language |
candidatePreferredLanguage | string | false | none | Candidate preferred language |
candidateEmail | string | false | none | Candidate email |
additionalEmails | candidateAdditionalEmails | false | none | Candidate additional emails |
candidateStatus | candidateStatus | false | none | Candidate status |
candidateMobilePhone | string | false | none | Candidate mobile phone number |
candidateId | UUID_V4 | false | none | Candidate id |
candidateCreatedAt | DateISO | false | none | Candidate createdAt date |
candidateUpdatedAt | DateISO | false | none | Candidate updatedAt date |
candidateDeadline | DateISO | false | none | Candidate deadline date |
candidateInternalNotes | string | false | none | Candidate notes |
candidateTagIds | [UUID_V4] | false | none | Candidate tag ids |
candidateTagNames | [string] | false | none | Candidate tag names |
candidateAssigneeId | UUID_V4 | false | none | Candidate Assignee id |
accountId | UUID_V4 | false | none | Account id |
accountName | string | false | none | Account name |
accountReference | string | false | none | Account reference |
companyId | UUID_V4 | false | none | Company id |
candidateCustomFields | object | false | none | none |
originalFormId | UUID_V4 | false | none | Form id |
formId | UUID_V4 | false | none | Candidate form id |
formName | string | false | none | Candidate form name |
formReference | string | false | none | Candidate form reference |
formFolder | string | false | none | Candidate form folder |
formCompletedAt | DateISO | false | none | Candidate form completion date |
formDynamicFields | object | false | none | Form dynamic fields entered by the candidate |
formContext | object | false | none | Form context prepared by system |
formMetadata | object | false | none | Candidate Form metadata (external properties) |
integrationExampleFormSignedData
{
"candidateName": "string",
"candidateFirstName": "string",
"candidateLastName": "string",
"candidateReference": "string",
"candidateLanguage": "string",
"candidatePreferredLanguage": "string",
"candidateEmail": "string",
"additionalEmails": [
"[email protected]"
],
"candidateStatus": "pending",
"candidateMobilePhone": "string",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateCreatedAt": "2019-09-12T15:36:09.264Z",
"candidateUpdatedAt": "2019-09-12T15:36:09.264Z",
"candidateDeadline": "2019-09-12T15:36:09.264Z",
"candidateInternalNotes": "string",
"candidateTagIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"candidateTagNames": [
"import",
"office",
"VIP"
],
"candidateAssigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountName": "string",
"accountReference": "string",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateCustomFields": {},
"originalFormId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formName": "string",
"formReference": "string",
"formFolder": "Registration",
"formCompletedAt": "2019-09-12T15:36:09.264Z",
"formSignedAt": "2019-09-12T15:36:09.264Z",
"formDynamicFields": {},
"formContext": {},
"formMetadata": {}
}
Example data of the 'formSigned' trigger event
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
candidateName | string | false | none | Candidate name which consist of firstName and lastName |
candidateFirstName | string | false | none | Candidate firstName |
candidateLastName | string | false | none | Candidate lastName |
candidateReference | string | false | none | Candidate reference |
candidateLanguage | string | false | none | Candidate language |
candidatePreferredLanguage | string | false | none | Candidate preferred language |
candidateEmail | string | false | none | Candidate email |
additionalEmails | candidateAdditionalEmails | false | none | Candidate additional emails |
candidateStatus | candidateStatus | false | none | Candidate status |
candidateMobilePhone | string | false | none | Candidate mobile phone number |
candidateId | UUID_V4 | false | none | Candidate id |
candidateCreatedAt | DateISO | false | none | Candidate createdAt date |
candidateUpdatedAt | DateISO | false | none | Candidate updatedAt date |
candidateDeadline | DateISO | false | none | Candidate deadline date |
candidateInternalNotes | string | false | none | Candidate notes |
candidateTagIds | [UUID_V4] | false | none | Candidate tag ids |
candidateTagNames | [string] | false | none | Candidate tag names |
candidateAssigneeId | UUID_V4 | false | none | Candidate Assignee id |
accountId | UUID_V4 | false | none | Account id |
accountName | string | false | none | Account name |
accountReference | string | false | none | Account reference |
companyId | UUID_V4 | false | none | Company id |
candidateCustomFields | object | false | none | none |
originalFormId | UUID_V4 | false | none | Form id |
formId | UUID_V4 | false | none | Candidate form id |
formName | string | false | none | Candidate form name |
formReference | string | false | none | Candidate form reference |
formFolder | string | false | none | Candidate form folder |
formCompletedAt | DateISO | false | none | Candidate form completion date |
formSignedAt | DateISO | false | none | Candidate form signing date |
formDynamicFields | object | false | none | Form dynamic fields entered by the candidate |
formContext | object | false | none | Form context prepared by system |
formMetadata | object | false | none | Candidate Form metadata (external properties) |
integrationExampleCandidateDeletedData
{
"candidateName": "string",
"candidateFirstName": "string",
"candidateLastName": "string",
"candidateReference": "string",
"candidateLanguage": "string",
"candidatePreferredLanguage": "string",
"candidateEmail": "string",
"additionalEmails": [
"[email protected]"
],
"candidateStatus": "pending",
"candidateMobilePhone": "string",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateCreatedAt": "2019-09-12T15:36:09.264Z",
"candidateUpdatedAt": "2019-09-12T15:36:09.264Z",
"candidateDeadline": "2019-09-12T15:36:09.264Z",
"candidateInternalNotes": "string",
"candidateTagIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"candidateTagNames": [
"import",
"office",
"VIP"
],
"candidateAssigneeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountName": "string",
"accountReference": "string",
"candidateCustomFields": {}
}
Example data of the 'candidateDeleted' trigger event
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
candidateName | string | false | none | Candidate name which consist of firstName and lastName |
candidateFirstName | string | false | none | Candidate firstName |
candidateLastName | string | false | none | Candidate lastName |
candidateReference | string | false | none | Candidate reference |
candidateLanguage | string | false | none | Candidate language |
candidatePreferredLanguage | string | false | none | Candidate preferred language |
candidateEmail | string | false | none | Candidate email |
additionalEmails | candidateAdditionalEmails | false | none | Candidate additional emails |
candidateStatus | candidateStatus | false | none | Candidate status |
candidateMobilePhone | string | false | none | Candidate mobile phone number |
candidateId | UUID_V4 | false | none | Candidate id |
candidateCreatedAt | DateISO | false | none | Candidate createdAt date |
candidateUpdatedAt | DateISO | false | none | Candidate updatedAt date |
candidateDeadline | DateISO | false | none | Candidate deadline date |
candidateInternalNotes | string | false | none | Candidate notes |
candidateTagIds | [UUID_V4] | false | none | Candidate tag ids |
candidateTagNames | [string] | false | none | Candidate tag names |
candidateAssigneeId | UUID_V4 | false | none | Candidate Assignee id |
accountId | UUID_V4 | false | none | Account id |
accountName | string | false | none | Account name |
accountReference | string | false | none | Account reference |
candidateCustomFields | object | false | none | none |
integrationExampleDaasFileParsedData
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"parserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validatorId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"status": "finished",
"validation": [
{
"type": "or",
"action": "score",
"score": 10,
"sequence": 1,
"isValid": true,
"validations": [
{
"rule": "string",
"method": "contains",
"value": {
"value": "value"
},
"fieldName": "firstName",
"fieldValue": "Field value",
"sequence": 1,
"isValid": true
}
]
}
],
"validationStatus": "validated",
"data": {},
"metadata": {},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Example data of the 'daasFileParsed' trigger event
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | true | none | Unique identifier for the entity |
companyId | UUID_V4 | true | none | Unique identifier for the entity |
documentTypeId | UUID_V4 | true | none | Unique identifier for the entity |
parserId | UUID_V4 | true | none | Unique identifier for the entity |
validatorId | UUID_V4 | false | none | Unique identifier for the entity |
status | daasRequestStatus | true | none | Request status |
validation | [daasRequestValidationGroup] | false | none | Array of daas request validations |
validationStatus | daasRequestValidationStatus | false | none | Request status |
data | object | true | none | Data of the parsing result |
metadata | object | true | none | This object will not be changed and you will receive it in the integration callback. Also you should be aware that these fields can be used in the rules during validation process |
createdAt | DateISO | true | none | Datetime in ISO format |
updatedAt | DateISO | true | none | Datetime in ISO format |
log
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"author": "string",
"description": "string",
"type": "string",
"status": "string",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"name": "Welcome letter",
"templateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"reference": "WELCOME_EN_DE_CREATED",
"delayInHours": 0,
"eventName": "candidateCreated",
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"languages": [
"en",
"fr",
"nl"
],
"recipients": {
"candidate": {
"enabled": true
},
"creator": {
"enabled": true
},
"customEmail": {
"enabled": true,
"email": "[email protected]"
},
"customFields": {
"enabled": true,
"fieldIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}
},
"replyTo": {
"type": "default",
"value": "[email protected]"
},
"isActive": true,
"tagsCondition": "or"
}
Scenario for handling candidate event.
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | object | false | none | none |
» id | UUID_V4 | true | none | Unique identifier for the entity |
» author | string | false | none | Log author |
» description | string | false | none | Log description |
» type | string | false | none | Log type |
» status | string | false | none | Log status |
» candidateId | UUID_V4 | false | none | Unique identifier for the entity |
» companyId | UUID_V4 | true | none | Unique identifier for the entity |
» createdAt | DateISO | true | none | Datetime in ISO format |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | scenarioBase | false | none | none |
mimeType
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": ".pdf name",
"extension": ".pdf",
"mime": "application/pdf",
"icon": ""
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | false | none | Unique identifier for the entity |
name | string | false | none | Mime Type name |
extension | string | false | none | Mime Type extension |
mime | string | false | none | Mime Type content type |
icon | string | false | none | Mime Type icon base64 string |
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"
}
A resource for candidates with which they will have to perform certain actions. Can be used to familiarize candidates with rules/contracts/approvals etc..
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | true | none | Unique identifier for the entity |
companyId | UUID_V4 | true | none | Unique identifier for the entity |
name | string | true | none | Resource name |
filename | string | false | none | Resource name |
type | resourceType | true | none | One of Resource type enumeration |
language | resourceLanguage | false | none | One of Resource language enumeration |
shareCode | string | false | none | Resource share code |
blocking | boolean | false | none | Is the candidate screen blocking by the resource popup |
version | number | false | none | Resource version number |
actions | resourceActions | false | none | Resource actions (at least one action required) |
content | resourceContent | false | none | Resource Content |
fields | [resourceDynamicField] | false | none | Array of Resource Dynamic Fields |
createdAt | DateISO | true | none | Datetime in ISO format |
updatedAt | DateISO | true | none | Datetime in ISO format |
resourceAction
"read"
An action that a candidate must perform with a resource
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | An action that a candidate must perform with a resource |
Enumerated Values
Property | Value |
---|---|
anonymous | read |
anonymous | complete |
anonymous | download |
resourceActions
[
"complete",
"download"
]
Resource actions (at least one action required)
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [resourceAction] | false | none | Resource actions (at least one action required) |
resourceContent
{
"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"
}
Resource Content
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
text | string(html) | false | none | Content text |
file | string | false | none | Resource attached file key |
originalFilename | string | false | none | Only File resource contents this field |
resourceContentCreate
{
"text": "\\n\\n\\n\\n\\n<p>{candidateFirstname}<br />Some candidate first name</p>\\n\\n"
}
Resource Content to create
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
text | string(html) | false | none | Content text |
resourceContentUpdate
{
"text": "\\n\\n\\n\\n\\n<p>{candidateFirstname}<br />Some candidate first name</p>\\n\\n"
}
Resource Content to update
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
text | string(html) | false | none | Content text |
resourceDynamicField
{
"reference": "firstNameRef",
"name": "First Name",
"contentType": "text",
"prefilled": "{candidateLastname}",
"editable": true,
"mandatory": false
}
Resource Dynamic Field
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
reference | string | true | none | Dynamic Field reference |
name | string | true | none | Dynamic Field name |
contentType | resourceDynamicFieldContentType | true | none | Dynamic field type in resource |
prefilled | resourceDynamicFieldPrefilled | true | none | The default value that will be substituted into this field. You can also use your custom fields for the candidate by starting with the {customField_{customFieldId}} prefix.It is also possible to use custom values, they don't need to be wrapped in {} . |
editable | boolean | true | none | Is Dynamic Field editable |
mandatory | boolean | true | none | Is Dynamic Field mandatory |
resourceDynamicFieldContentType
"text"
Dynamic field type in resource
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | Dynamic field type in resource |
Enumerated Values
Property | Value |
---|---|
anonymous | text |
anonymous | |
anonymous | phone |
anonymous | mobilePhone |
anonymous | checkbox |
anonymous | signature |
resourceDynamicFieldPrefilled
"{candidateLastname}"
The default value that will be substituted into this field.
You can also use your custom fields for the candidate by starting with the {customField_{customFieldId}}
prefix.
It is also possible to use custom values, they don't need to be wrapped in {}
.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | The default value that will be substituted into this field. You can also use your custom fields for the candidate by starting with the {customField_{customFieldId}} prefix.It is also possible to use custom values, they don't need to be wrapped in {} . |
Enumerated Values
Property | Value |
---|---|
anonymous | {companyName} |
anonymous | {companyLogo} |
anonymous | {accountName} |
anonymous | {accountWelcomeText} |
anonymous | {accountReference} |
anonymous | {candidateFirstname} |
anonymous | {candidateLastname} |
anonymous | {candidateEmail} |
anonymous | {candidateReference} |
anonymous | {candidatePhone} |
anonymous | {resourceName} |
anonymous | {dateNow} |
resourceType
"editable"
One of Resource type enumeration
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | One of Resource type enumeration |
Enumerated Values
Property | Value |
---|---|
anonymous | readonly |
anonymous | editable |
anonymous | file |
resourceLanguage
"en"
One of Resource language enumeration
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | One of Resource language enumeration |
Enumerated Values
Property | Value |
---|---|
anonymous | en |
anonymous | fr |
anonymous | nl |
anonymous | de |
anonymous | it |
anonymous | pl |
anonymous | ro |
anonymous | sq |
anonymous | be |
anonymous | bg |
anonymous | hr |
anonymous | cs |
anonymous | da |
anonymous | et |
anonymous | fi |
anonymous | el |
anonymous | hu |
anonymous | is |
anonymous | ga |
anonymous | lv |
anonymous | lt |
anonymous | mk |
anonymous | mt |
anonymous | no |
anonymous | pt |
anonymous | ru |
anonymous | sr |
anonymous | sk |
anonymous | sl |
anonymous | es |
anonymous | sv |
anonymous | uk |
anonymous | cy |
resourceArray
[
{
"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"
}
]
Array of resources
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [resource] | false | none | Array of resources |
resourceCreate
{
"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"
}
}
Properties
oneOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | any | false | none | none |
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» anonymous | resourceBase | false | none | Create a new resource |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» anonymous | object | false | none | none |
»» content | resourceContentCreate | true | none | Resource Content to create |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | resourceBaseWithAttachedFile | false | none | Create Resource with Attached File |
resourceBase
{
"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
}
]
}
Create a new resource
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
name | string | true | none | Resource name |
filename | string | true | none | Resource file name |
actions | resourceActions | true | none | Resource actions (at least one action required) |
language | resourceLanguage | false | none | One of Resource language enumeration |
blocking | boolean | false | none | Is the candidate screen blocking by the resource popup |
fields | [resourceDynamicField] | false | none | Array of Resource Dynamic Fields |
resourceBaseWithAttachedFile
{
"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
}
],
"file": "There should be your file in binary format"
}
Create Resource with Attached File
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | resourceBase | false | none | Create a new resource |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | object | false | none | none |
» file | string(binary) | true | none | The file to be attached to the resource. |
resourceImport
{
"shareCode": ""
}
Import resource by share code
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
shareCode | string | true | none | Resource share code |
resourceUpdate
{
"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"
}
}
Properties
oneOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | any | false | none | none |
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» anonymous | resourceBase | false | none | Create a new resource |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» anonymous | object | false | none | none |
»» content | resourceContentUpdate | false | none | Resource Content to update |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | resourceBaseWithAttachedFile | false | none | Create Resource with Attached File |
resourceValidateSharedCode
{
"shareCode": ""
}
Validate resource shared code
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
shareCode | string | true | none | Resource share code |
resourceShareResponse
{
"shareCode": "DQ6M57AH"
}
Share code which can be used to import resource to any company
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
shareCode | string | false | none | none |
resourceSuccessResponse
{
"success": true
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
success | boolean | false | none | none |
resourceValidateSharedCodeResponse
{
"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"
}
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
resource | resource | false | none | A resource for candidates with which they will have to perform certain actions. Can be used to familiarize candidates with rules/contracts/approvals etc.. |
registrationPage
{
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"themeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "string",
"language": "en",
"token": "8f2b44db61bb96e6",
"isActive": false,
"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"
}
Registration page
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
accountId | UUID_V4 | true | none | Unique identifier for the entity |
themeId | UUID_V4 | true | none | Unique identifier for the entity |
name | string | true | none | Registration page name |
language | language | true | none | Registration Page Language |
token | string | true | none | Registration Page access token |
isActive | boolean | false | none | Registration Page is active or not |
id | UUID_V4 | true | none | Unique identifier for the entity |
companyId | UUID_V4 | true | none | Unique identifier for the entity |
createdAt | DateISO | true | none | Datetime in ISO format |
updatedAt | DateISO | true | none | Datetime in ISO format |
registrationPageArray
[
{
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"themeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "string",
"language": "en",
"token": "8f2b44db61bb96e6",
"isActive": false,
"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"
}
]
Registration Page Collection
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [registrationPage] | false | none | Registration Page Collection |
registrationPageBase
{
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"themeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "string",
"language": "en",
"token": "8f2b44db61bb96e6",
"isActive": false
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
accountId | UUID_V4 | false | none | Unique identifier for the entity |
themeId | UUID_V4 | false | none | Unique identifier for the entity |
name | string | false | none | Registration page name |
language | language | false | none | Registration Page Language |
token | string | false | none | Registration Page access token |
isActive | boolean | false | none | Registration Page is active or not |
registrationPageCreate
{
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"themeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "string",
"language": "en",
"token": "8f2b44db61bb96e6",
"isActive": false
}
Create Registration Page
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
accountId | UUID_V4 | true | none | Unique identifier for the entity |
themeId | UUID_V4 | true | none | Unique identifier for the entity |
name | string | true | none | Registration page name |
language | language | true | none | Registration Page Language |
token | string | true | none | Registration Page access token |
isActive | boolean | false | none | Registration Page is active or not |
registrationPageFindResponse
{
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"themeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "string",
"language": "en",
"token": "8f2b44db61bb96e6",
"isActive": false,
"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",
"account": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"aboutText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedBoxText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"documents": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"registrationPageId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "string",
"comment": "string",
"commentType": "info",
"isMandatory": false,
"folder": "string",
"documentType": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"name": "ASAP",
"reference": "dt_asap_eu",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"description": "Document Type description",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validationType": "auto",
"integrationSendOriginal": false,
"convertToPDF": false,
"isUnique": false,
"expiresInMonths": 2,
"isRectoVerso": false,
"advancedUploader": false,
"advancedUploaderSettings": {
"upload": false,
"scenario": "MrzAndLocate"
},
"skipBackup": false
}
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"registrationPageId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "string",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"form": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Work Permit",
"reference": "work_permit",
"shareCode": "",
"type": "editable",
"language": "en",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"updatedById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
}
],
"fields": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"registrationPageId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "string",
"reference": "string",
"isMandatory": false,
"isBase": false,
"sequence": 0,
"customField": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Document Number",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"reference": "DOC_NUM",
"fieldType": "string",
"description": "This custom field is required to store the passport series.",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"visibilityRules": {
"admin": {
"visible": true,
"editable": true,
"mandatory": false
},
"candidate": {
"visible": true,
"editable": true,
"mandatory": false
}
},
"accountIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"docTypeIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"orderNbr": 3
}
}
],
"tags": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"registrationPageId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"tag": {
"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",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"registrationPageId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"viewsTotal": 0,
"submissionsTotal": 0
},
"share": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"registrationPageId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"qrCodeFileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"link": "https://register.dev.checkhub.io/79a365e745024b6c"
}
}
Find Registration Pages response
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | registrationPage | false | none | Registration page |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | registrationPageIncludedRelations | false | none | Registration Page included relations |
registrationPageFindByIdResponse
{
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"themeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "string",
"language": "en",
"token": "8f2b44db61bb96e6",
"isActive": false,
"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",
"account": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"aboutText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedBoxText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"documents": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"registrationPageId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "string",
"comment": "string",
"commentType": "info",
"isMandatory": false,
"folder": "string",
"documentType": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"name": "ASAP",
"reference": "dt_asap_eu",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"description": "Document Type description",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validationType": "auto",
"integrationSendOriginal": false,
"convertToPDF": false,
"isUnique": false,
"expiresInMonths": 2,
"isRectoVerso": false,
"advancedUploader": false,
"advancedUploaderSettings": {
"upload": false,
"scenario": "MrzAndLocate"
},
"skipBackup": false
}
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"registrationPageId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "string",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"form": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Work Permit",
"reference": "work_permit",
"shareCode": "",
"type": "editable",
"language": "en",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"updatedById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
}
],
"fields": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"registrationPageId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "string",
"reference": "string",
"isMandatory": false,
"isBase": false,
"sequence": 0,
"customField": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Document Number",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"reference": "DOC_NUM",
"fieldType": "string",
"description": "This custom field is required to store the passport series.",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"visibilityRules": {
"admin": {
"visible": true,
"editable": true,
"mandatory": false
},
"candidate": {
"visible": true,
"editable": true,
"mandatory": false
}
},
"accountIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"docTypeIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"orderNbr": 3
}
}
],
"tags": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"registrationPageId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"tag": {
"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",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"registrationPageId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"viewsTotal": 0,
"submissionsTotal": 0
},
"share": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"registrationPageId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"qrCodeFileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"link": "https://register.dev.checkhub.io/79a365e745024b6c"
}
}
Find Registration Page response
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | registrationPage | false | none | Registration page |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | registrationPageIncludedRelations | false | none | Registration Page included relations |
registrationPageIncludedRelations
{
"account": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Tesla Digital",
"reference": "ACC_TESLA_DIG_01",
"welcomeText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"aboutText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedBoxText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"completedText": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"en": "<p>English</p>",
"fr": "<p>Français</p>",
"nl": "<p>Nederlands</p>",
"de": "<p>Deutsch</p>",
"it": "<p>Italiano</p>",
"pl": "<p>Polski</p>",
"ro": "<p>Română</p>",
"sq": "<p>Shqip</p>",
"be": "<p>Беларуская</p>",
"bg": "<p>Български</p>",
"hr": "<p>Hrvatski</p>",
"cs": "<p>Čeština</p>",
"da": "<p>Dansk</p>",
"et": "<p>Eesti</p>",
"fi": "<p>Suomi</p>",
"el": "<p>Ελληνικά</p>",
"hu": "<p>Magyar</p>",
"is": "<p>Íslenska</p>",
"ga": "<p>Gaeilge</p>",
"lv": "<p>Latviešu</p>",
"lt": "<p>Lietuvių</p>",
"mk": "<p>Македонски</p>",
"mt": "<p>Malti</p>",
"no": "<p>Norsk</p>",
"pt": "<p>Português</p>",
"ru": "<p>Русский</p>",
"sr": "<p>Српски</p>",
"sk": "<p>Slovenčina</p>",
"sl": "<p>Slovenščina</p>",
"es": "<p>Español</p>",
"sv": "<p>Svenska</p>",
"uk": "<p>Українська</p>",
"cy": "<p>Cymraeg</p>"
},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"documents": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"registrationPageId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "string",
"comment": "string",
"commentType": "info",
"isMandatory": false,
"folder": "string",
"documentType": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"name": "ASAP",
"reference": "dt_asap_eu",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"description": "Document Type description",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validationType": "auto",
"integrationSendOriginal": false,
"convertToPDF": false,
"isUnique": false,
"expiresInMonths": 2,
"isRectoVerso": false,
"advancedUploader": false,
"advancedUploaderSettings": {
"upload": false,
"scenario": "MrzAndLocate"
},
"skipBackup": false
}
}
],
"forms": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"registrationPageId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "string",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"form": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Work Permit",
"reference": "work_permit",
"shareCode": "",
"type": "editable",
"language": "en",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"updatedById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
}
],
"fields": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"registrationPageId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "string",
"reference": "string",
"isMandatory": false,
"isBase": false,
"sequence": 0,
"customField": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Document Number",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"reference": "DOC_NUM",
"fieldType": "string",
"description": "This custom field is required to store the passport series.",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"visibilityRules": {
"admin": {
"visible": true,
"editable": true,
"mandatory": false
},
"candidate": {
"visible": true,
"editable": true,
"mandatory": false
}
},
"accountIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"docTypeIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"orderNbr": 3
}
}
],
"tags": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"registrationPageId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"tag": {
"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",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"registrationPageId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"viewsTotal": 0,
"submissionsTotal": 0
},
"share": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"registrationPageId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"qrCodeFileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"link": "https://register.dev.checkhub.io/79a365e745024b6c"
}
}
Registration Page included relations
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
account | account | false | none | none |
documents | [registrationPageDocument] | false | none | Related documents |
forms | [registrationPageForm] | false | none | Related documents |
fields | [registrationPageField] | false | none | Related documents |
tags | [registrationPageTag] | false | none | Related documents |
statistic | registrationPageStatistic | false | none | none |
share | registrationPageShare | false | none | none |
registrationPageShare
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"registrationPageId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"qrCodeFileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"link": "https://register.dev.checkhub.io/79a365e745024b6c"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | false | none | Unique identifier for the entity |
companyId | UUID_V4 | false | none | Unique identifier for the entity |
registrationPageId | UUID_V4 | false | none | Unique identifier for the entity |
qrCodeFileId | UUID_V4 | false | none | Registration page share QR code file id |
link | string | false | none | Registration page share link |
registrationPageStatistic
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"registrationPageId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"viewsTotal": 0,
"submissionsTotal": 0
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | false | none | Unique identifier for the entity |
companyId | UUID_V4 | false | none | Unique identifier for the entity |
registrationPageId | UUID_V4 | false | none | Unique identifier for the entity |
viewsTotal | number | false | none | Registration page views total |
submissionsTotal | number | false | none | Registration page submissions total |
registrationPageDocument
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"registrationPageId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "string",
"comment": "string",
"commentType": "info",
"isMandatory": false,
"folder": "string",
"documentType": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"name": "ASAP",
"reference": "dt_asap_eu",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"description": "Document Type description",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validationType": "auto",
"integrationSendOriginal": false,
"convertToPDF": false,
"isUnique": false,
"expiresInMonths": 2,
"isRectoVerso": false,
"advancedUploader": false,
"advancedUploaderSettings": {
"upload": false,
"scenario": "MrzAndLocate"
},
"skipBackup": false
}
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | false | none | Unique identifier for the entity |
companyId | UUID_V4 | false | none | Unique identifier for the entity |
registrationPageId | UUID_V4 | false | none | Unique identifier for the entity |
documentTypeId | UUID_V4 | false | none | Unique identifier for the entity |
name | string | false | none | Registration page document name |
comment | string | false | none | Registration page document comment |
commentType | candidateDocumentTypeCommentType | false | none | Registration page document comment type |
isMandatory | boolean | false | none | It says that Registration page document is mandatory or optional for the candidate |
folder | string | false | none | Registration page document folder name |
documentType | documentType | false | none | none |
registrationPageForm
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"registrationPageId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "string",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"form": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Work Permit",
"reference": "work_permit",
"shareCode": "",
"type": "editable",
"language": "en",
"actions": [
"complete",
"download"
],
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"createdById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"updatedById": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | false | none | Unique identifier for the entity |
companyId | UUID_V4 | false | none | Unique identifier for the entity |
registrationPageId | UUID_V4 | false | none | Unique identifier for the entity |
formId | UUID_V4 | false | none | Unique identifier for the entity |
name | string | false | none | Registration page form name |
actions | formActions | false | none | Form actions (at least one action required); Please note that allowable actions depend on the type of the original form:
|
isMandatory | boolean | false | none | Is Registration page form mandatory |
fileId | UUID_V4 | false | none | Registration page form file id. It is needed for form with attached file |
signatureId | UUID_V4 | false | none | Registration page form signature id. It should be used only when action 'eSign' is included |
form | form | false | none | Form properties |
registrationPageField
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"registrationPageId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"customFieldId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "string",
"reference": "string",
"isMandatory": false,
"isBase": false,
"sequence": 0,
"customField": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Document Number",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"reference": "DOC_NUM",
"fieldType": "string",
"description": "This custom field is required to store the passport series.",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"visibilityRules": {
"admin": {
"visible": true,
"editable": true,
"mandatory": false
},
"candidate": {
"visible": true,
"editable": true,
"mandatory": false
}
},
"accountIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"docTypeIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"orderNbr": 3
}
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | false | none | Unique identifier for the entity |
companyId | UUID_V4 | false | none | Unique identifier for the entity |
registrationPageId | UUID_V4 | false | none | Unique identifier for the entity |
customFieldId | UUID_V4 | false | none | Unique identifier for the entity |
name | string | false | none | Registration page field name |
reference | string | false | none | Registration page field reference |
isMandatory | boolean | false | none | It says that Registration page field is mandatory or optional for the candidate |
isBase | boolean | false | none | It says that Registration page field is base or optional for the candidate |
sequence | number | false | none | Registration page field sequence in the rendered content |
customField | customField | false | none | Custom fields for an entity |
registrationPageTag
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"registrationPageId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"tag": {
"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"
}
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | false | none | Unique identifier for the entity |
companyId | UUID_V4 | false | none | Unique identifier for the entity |
registrationPageId | UUID_V4 | false | none | Unique identifier for the entity |
tagId | UUID_V4 | false | none | Unique identifier for the entity |
tag | tag | false | none | Tag for grouping data based on similarity |
scenario
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypes": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"name": "ASAP",
"reference": "dt_asap_eu",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"description": "Document Type description",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validationType": "auto",
"integrationSendOriginal": false,
"convertToPDF": false,
"isUnique": false,
"expiresInMonths": 2,
"isRectoVerso": false,
"advancedUploader": false,
"advancedUploaderSettings": {
"upload": false,
"scenario": "MrzAndLocate"
},
"skipBackup": false
}
],
"tags": [
{
"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"
}
],
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Welcome letter",
"templateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"reference": "WELCOME_EN_DE_CREATED",
"delayInHours": 0,
"eventName": "candidateCreated",
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"languages": [
"en",
"fr",
"nl"
],
"recipients": {
"candidate": {
"enabled": true
},
"creator": {
"enabled": true
},
"customEmail": {
"enabled": true,
"email": "[email protected]"
},
"customFields": {
"enabled": true,
"fieldIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}
},
"replyTo": {
"type": "default",
"value": "[email protected]"
},
"isActive": true,
"tagsCondition": "or"
}
Scenario for handling candidate event.
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | object | false | none | none |
» id | UUID_V4 | true | none | Unique identifier for the entity |
» companyId | UUID_V4 | true | none | Unique identifier for the entity |
» documentTypes | [documentType] | false | none | Scenario document types |
» tags | [tag] | false | none | Scenario document tags |
» createdAt | DateISO | true | none | Datetime in ISO format |
» updatedAt | DateISO | true | none | Datetime in ISO format |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | scenarioBase | false | none | none |
scenarioArray
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypes": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"name": "ASAP",
"reference": "dt_asap_eu",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"description": "Document Type description",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validationType": "auto",
"integrationSendOriginal": false,
"convertToPDF": false,
"isUnique": false,
"expiresInMonths": 2,
"isRectoVerso": false,
"advancedUploader": false,
"advancedUploaderSettings": {
"upload": false,
"scenario": "MrzAndLocate"
},
"skipBackup": false
}
],
"tags": [
{
"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"
}
],
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Welcome letter",
"templateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"reference": "WELCOME_EN_DE_CREATED",
"delayInHours": 0,
"eventName": "candidateCreated",
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"languages": [
"en",
"fr",
"nl"
],
"recipients": {
"candidate": {
"enabled": true
},
"creator": {
"enabled": true
},
"customEmail": {
"enabled": true,
"email": "[email protected]"
},
"customFields": {
"enabled": true,
"fieldIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}
},
"replyTo": {
"type": "default",
"value": "[email protected]"
},
"isActive": true,
"tagsCondition": "or"
}
]
Array of scenarios
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [scenario] | false | none | Array of scenarios |
scenarioCreate
{
"name": "Welcome letter",
"templateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"reference": "WELCOME_EN_DE_CREATED",
"delayInHours": 0,
"eventName": "candidateCreated",
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"languages": [
"en",
"fr",
"nl"
],
"recipients": {
"candidate": {
"enabled": true
},
"creator": {
"enabled": true
},
"customEmail": {
"enabled": true,
"email": "[email protected]"
},
"customFields": {
"enabled": true,
"fieldIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}
},
"replyTo": {
"type": "default",
"value": "[email protected]"
},
"isActive": true,
"tagsCondition": "or",
"tags": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"documentTypes": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}
Create Scenario body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
name | string | true | none | Scenario name |
templateId | UUID_V4 | true | none | Unique identifier for the entity |
reference | string | true | none | Scenario reference |
delayInHours | number | false | none | Delay in sending after the event is triggered (only for candidatePending) |
eventName | scenarioEvent | true | none | Scenario event type |
accounts | scenarioAccounts | false | none | Accounts for which this scenario will work. |
languages | scenarioLanguages | true | none | The set of languages for which the scenario can be executed. |
recipients | scenarioRecipients | true | none | Options for who will receive notifications. |
replyTo | scenarioReplyTo | false | none | Scenario notifications replyTo options. |
isActive | boolean | false | none | Is the scenario enabled |
tagsCondition | scenarioTagsCondition | false | none | Conditions for added tags. |
tags | [UUID_V4] | false | none | Scenario tag ids |
documentTypes | [UUID_V4] | false | none | Scenario document type ids |
scenarioAccounts
[
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
Accounts for which this scenario will work.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [UUID_V4] | false | none | Accounts for which this scenario will work. |
scenarioEvent
"candidateCreated"
Scenario event type
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | Scenario event type |
Enumerated Values
Property | Value |
---|---|
anonymous | candidateCreated |
anonymous | candidatePending |
anonymous | candidateCompleted |
anonymous | candidateCompletedWithFlows |
anonymous | candidateManualNotification |
anonymous | candidateUploadedFile |
anonymous | candidateUploadedFileRejected |
anonymous | candidateUploadedFileValidated |
anonymous | candidateUploadedFilePending |
anonymous | candidateDocumentExpired |
anonymous | nextSerialSignature |
scenarioBase
{
"name": "Welcome letter",
"templateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"reference": "WELCOME_EN_DE_CREATED",
"delayInHours": 0,
"eventName": "candidateCreated",
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"languages": [
"en",
"fr",
"nl"
],
"recipients": {
"candidate": {
"enabled": true
},
"creator": {
"enabled": true
},
"customEmail": {
"enabled": true,
"email": "[email protected]"
},
"customFields": {
"enabled": true,
"fieldIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}
},
"replyTo": {
"type": "default",
"value": "[email protected]"
},
"isActive": true,
"tagsCondition": "or"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
name | string | false | none | Scenario name |
templateId | UUID_V4 | false | none | Unique identifier for the entity |
reference | string | false | none | Scenario reference |
delayInHours | number | false | none | Delay in sending after the event is triggered (only for candidatePending) |
eventName | scenarioEvent | false | none | Scenario event type |
accounts | scenarioAccounts | false | none | Accounts for which this scenario will work. |
languages | scenarioLanguages | false | none | The set of languages for which the scenario can be executed. |
recipients | scenarioRecipients | false | none | Options for who will receive notifications. |
replyTo | scenarioReplyTo | false | none | Scenario notifications replyTo options. |
isActive | boolean | false | none | Is the scenario enabled |
tagsCondition | scenarioTagsCondition | false | none | Conditions for added tags. |
scenarioUpdate
{
"name": "Welcome letter",
"templateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"reference": "WELCOME_EN_DE_CREATED",
"delayInHours": 0,
"eventName": "candidateCreated",
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"languages": [
"en",
"fr",
"nl"
],
"recipients": {
"candidate": {
"enabled": true
},
"creator": {
"enabled": true
},
"customEmail": {
"enabled": true,
"email": "[email protected]"
},
"customFields": {
"enabled": true,
"fieldIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}
},
"replyTo": {
"type": "default",
"value": "[email protected]"
},
"isActive": true,
"tagsCondition": "or",
"tags": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"documentTypes": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}
Update Scenario body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
name | string | false | none | Scenario name |
templateId | UUID_V4 | false | none | Unique identifier for the entity |
reference | string | false | none | Scenario reference |
delayInHours | number | false | none | Delay in sending after the event is triggered (only for candidatePending) |
eventName | scenarioEvent | false | none | Scenario event type |
accounts | scenarioAccounts | false | none | Accounts for which this scenario will work. |
languages | scenarioLanguages | false | none | The set of languages for which the scenario can be executed. |
recipients | scenarioRecipients | false | none | Options for who will receive notifications. |
replyTo | scenarioReplyTo | false | none | Scenario notifications replyTo options. |
isActive | boolean | false | none | Is the scenario enabled |
tagsCondition | scenarioTagsCondition | false | none | Conditions for added tags. |
tags | [UUID_V4] | false | none | Scenario tag ids |
documentTypes | [UUID_V4] | false | none | Scenario document type ids |
scenarioInitiateManually
{
"scenarioId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"custom": {
"email": {
"subject": "Your personal access",
"content": "<div>Hey John</div>",
"withContentWrapper": true,
"sender": {
"email": "[email protected]",
"replyTo": "[email protected]",
"name": "Sender Name"
}
},
"sms": {
"content": "Your personal access link: "
}
}
}
Data for manual notification
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
scenarioId | UUID_V4 | true | none | Unique identifier for the entity |
candidateId | UUID_V4 | true | none | Unique identifier for the entity |
custom | object | false | none | Data for replacing default data in scenario |
object | false | none | Data for replacing default data in scenario | |
»» subject | string | false | none | Custom email subject |
»» content | string | false | none | Custom email content |
»» withContentWrapper | boolean | false | none | Use default email content wrapper |
»» sender | object | false | none | Sender data |
string | false | none | Sender email | |
»»» replyTo | string | false | none | Reply to email |
»»» name | string | false | none | Sender name |
» sms | object | false | none | Data for replacing default data in scenario |
»» content | string | false | none | Custom sms content |
scenarioInitiateManuallyResponse
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"scenarioId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"templateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"method": "email",
"partNbr": 1,
"triggerType": "automatic",
"webhooks": "string",
"uniqueEventId": "string",
"target": "[email protected]",
"delayedSending": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
Array of activity logs
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [candidateLogMessageActivity] | false | none | Array of activity logs |
scenarioLanguage
"en"
The candidate's language as a condition for fulfillment
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | The candidate's language as a condition for fulfillment |
Enumerated Values
Property | Value |
---|---|
anonymous | en |
anonymous | fr |
anonymous | nl |
anonymous | de |
anonymous | it |
anonymous | pl |
anonymous | ro |
anonymous | sq |
anonymous | be |
anonymous | bg |
anonymous | hr |
anonymous | cs |
anonymous | da |
anonymous | et |
anonymous | fi |
anonymous | el |
anonymous | hu |
anonymous | is |
anonymous | ga |
anonymous | lv |
anonymous | lt |
anonymous | mk |
anonymous | mt |
anonymous | no |
anonymous | pt |
anonymous | ru |
anonymous | sr |
anonymous | sk |
anonymous | sl |
anonymous | es |
anonymous | sv |
anonymous | uk |
anonymous | cy |
scenarioLanguages
[
"en",
"fr",
"nl"
]
The set of languages for which the scenario can be executed.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [scenarioLanguage] | false | none | The set of languages for which the scenario can be executed. |
scenarioRecipients
{
"candidate": {
"enabled": true
},
"creator": {
"enabled": true
},
"customEmail": {
"enabled": true,
"email": "[email protected]"
},
"customFields": {
"enabled": true,
"fieldIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}
}
Options for who will receive notifications.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
candidate | object | true | none | The candidate for whom the scenario worked. |
» enabled | boolean | false | none | none |
creator | object | true | none | The user who created the candidate. |
» enabled | boolean | false | none | none |
customEmail | object | true | none | none |
» enabled | boolean | false | none | none |
string(email) | false | none | Any email address. It will be used if customEmail.enabled is true |
|
customFields | object | true | none | none |
» enabled | boolean | false | none | none |
» fieldIds | [UUID_V4] | false | none | Ids of candidate custom fields with type email. |
scenarioTagsCondition
"or"
Conditions for added tags.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | Conditions for added tags. |
Enumerated Values
Property | Value |
---|---|
anonymous | or |
anonymous | and |
scenarioFindResponse
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypes": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"name": "ASAP",
"reference": "dt_asap_eu",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"description": "Document Type description",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validationType": "auto",
"integrationSendOriginal": false,
"convertToPDF": false,
"isUnique": false,
"expiresInMonths": 2,
"isRectoVerso": false,
"advancedUploader": false,
"advancedUploaderSettings": {
"upload": false,
"scenario": "MrzAndLocate"
},
"skipBackup": false
}
],
"tags": [
{
"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"
}
],
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Welcome letter",
"templateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"reference": "WELCOME_EN_DE_CREATED",
"delayInHours": 0,
"eventName": "candidateCreated",
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"languages": [
"en",
"fr",
"nl"
],
"recipients": {
"candidate": {
"enabled": true
},
"creator": {
"enabled": true
},
"customEmail": {
"enabled": true,
"email": "[email protected]"
},
"customFields": {
"enabled": true,
"fieldIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}
},
"replyTo": {
"type": "default",
"value": "[email protected]"
},
"isActive": true,
"tagsCondition": "or",
"company": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it",
"pl",
"ro",
"sq",
"be",
"bg",
"hr",
"cs",
"da",
"et",
"fi",
"el",
"hu",
"is",
"ga",
"lv",
"lt",
"mk",
"mt",
"no",
"pt",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"uk",
"cy"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
},
"template": {
"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": "ASAP",
"type": "email",
"email": {
"editor": "tinymce",
"subject": "Welcome to Tesla!",
"content": "<div>Welcome to Tesla! </div><div>Here is your link for adding documents: `{link}`</div>",
"design": {},
"css": ".welcome {\n font-size: 25px;\n}"
},
"sms": {
"content": "Welcome to Tesla!\n Here is your link for adding documents: ..."
}
}
}
]
Scenario Collection
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | scenario | false | none | Scenario for handling candidate event. |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | scenarioRelations | false | none | Scenario included relations |
scenarioFindByIdResponse
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypes": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"name": "ASAP",
"reference": "dt_asap_eu",
"nameI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"description": "Document Type description",
"descriptionI18n": {
"en": "",
"fr": "",
"nl": "",
"de": "",
"it": "",
"pl": "",
"ro": "",
"sq": "",
"be": "",
"bg": "",
"hr": "",
"cs": "",
"da": "",
"et": "",
"fi": "",
"el": "",
"hu": "",
"is": "",
"ga": "",
"lv": "",
"lt": "",
"mk": "",
"mt": "",
"no": "",
"pt": "",
"ru": "",
"sr": "",
"sk": "",
"sl": "",
"es": "",
"sv": "",
"uk": "",
"cy": ""
},
"documentParserId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentValidationSetId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"validationType": "auto",
"integrationSendOriginal": false,
"convertToPDF": false,
"isUnique": false,
"expiresInMonths": 2,
"isRectoVerso": false,
"advancedUploader": false,
"advancedUploaderSettings": {
"upload": false,
"scenario": "MrzAndLocate"
},
"skipBackup": false
}
],
"tags": [
{
"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"
}
],
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"name": "Welcome letter",
"templateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"reference": "WELCOME_EN_DE_CREATED",
"delayInHours": 0,
"eventName": "candidateCreated",
"accounts": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
],
"languages": [
"en",
"fr",
"nl"
],
"recipients": {
"candidate": {
"enabled": true
},
"creator": {
"enabled": true
},
"customEmail": {
"enabled": true,
"email": "[email protected]"
},
"customFields": {
"enabled": true,
"fieldIds": [
"d3ccc75a-7f76-41f8-9ddf-c61622c8e091"
]
}
},
"replyTo": {
"type": "default",
"value": "[email protected]"
},
"isActive": true,
"tagsCondition": "or",
"company": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it",
"pl",
"ro",
"sq",
"be",
"bg",
"hr",
"cs",
"da",
"et",
"fi",
"el",
"hu",
"is",
"ga",
"lv",
"lt",
"mk",
"mt",
"no",
"pt",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"uk",
"cy"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
},
"template": {
"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": "ASAP",
"type": "email",
"email": {
"editor": "tinymce",
"subject": "Welcome to Tesla!",
"content": "<div>Welcome to Tesla! </div><div>Here is your link for adding documents: `{link}`</div>",
"design": {},
"css": ".welcome {\n font-size: 25px;\n}"
},
"sms": {
"content": "Welcome to Tesla!\n Here is your link for adding documents: ..."
}
}
}
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | scenario | false | none | Scenario for handling candidate event. |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | scenarioRelations | false | none | Scenario included relations |
scenarioRelations
{
"company": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it",
"pl",
"ro",
"sq",
"be",
"bg",
"hr",
"cs",
"da",
"et",
"fi",
"el",
"hu",
"is",
"ga",
"lv",
"lt",
"mk",
"mt",
"no",
"pt",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"uk",
"cy"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
},
"tags": [
{
"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"
}
],
"template": {
"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": "ASAP",
"type": "email",
"email": {
"editor": "tinymce",
"subject": "Welcome to Tesla!",
"content": "<div>Welcome to Tesla! </div><div>Here is your link for adding documents: `{link}`</div>",
"design": {},
"css": ".welcome {\n font-size: 25px;\n}"
},
"sms": {
"content": "Welcome to Tesla!\n Here is your link for adding documents: ..."
}
}
}
Scenario included relations
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
company | company | false | none | Related Company |
tags | tagArray | false | none | Related Tags (part of condition) |
template | template | false | none | Related Template |
scenarioReplyTo
{
"type": "default",
"value": "[email protected]"
}
Scenario notifications replyTo options.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
type | scenarioReplyToType | true | none | Scenario reply to type |
value | string | false | none | Scenario replyTo valid email value. It is required only for following types (customField, custom) |
scenarioReplyToType
"default"
Scenario reply to type
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | Scenario reply to type |
Enumerated Values
Property | Value |
---|---|
anonymous | default |
anonymous | candidateCreator |
anonymous | customField |
anonymous | custom |
downloadFileResponse
"PDF-1.41 0 obj\n--\n/Title (123)\n/Creator (321)"
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string(binary) | false | none | none |
signatureMethod
"string"
Signature method that is available for signers
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | Signature method that is available for signers |
signatureMethods
[
"string"
]
The list of available signature methods for signers
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [signatureMethod] | false | none | The list of available signature methods for signers |
signatureLayout
"standard"
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | none |
Enumerated Values
Property | Value |
---|---|
anonymous | standard |
anonymous | custom |
signatureCreateRoles
[
{
"roleId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isActive": false,
"sendSignedFile": false,
"sequence": 0
}
]
Signature Create Roles.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [signatureCreateRole] | false | none | Signature Create Roles. |
signatureCreateRole
{
"roleId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isActive": false,
"sendSignedFile": false,
"sequence": 0
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
roleId | UUID_V4 | true | none | Unique identifier for the entity |
isActive | boolean | true | none | Is serial signature |
sendSignedFile | boolean | false | none | It is needed only for 'candidate' role to send signed file over the email sending |
sequence | number | false | none | Set only if signature is serial. It should be started from 0 |
signatureBase
{
"providerId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"description": ""
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
providerId | UUID_V4 | false | none | Unique identifier for the entity |
name | string | false | none | Signature name |
description | string | false | none | Signature name |
signature
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isSerial": false,
"methods": [
"string"
],
"defaultMethod": "string",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"providerId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"description": ""
}
Signature
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | object | false | none | none |
» id | UUID_V4 | false | none | Unique identifier for the entity |
» companyId | UUID_V4 | false | none | Unique identifier for the entity |
» isSerial | boolean | false | none | Is serial signature |
» methods | signatureMethods | false | none | The list of available signature methods for signers |
» defaultMethod | signatureMethod | false | none | Signature method that is available for signers |
» createdAt | DateISO | false | none | Datetime in ISO format |
» updatedAt | DateISO | false | none | Datetime in ISO format |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | signatureBase | false | none | none |
signatureCreate
{
"providerId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"description": "",
"roles": [
{
"roleId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isActive": false,
"sendSignedFile": false,
"sequence": 0
}
],
"isSerial": false
}
Create Signature body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
providerId | UUID_V4 | true | none | Unique identifier for the entity |
name | string | true | none | Signature name |
description | string | false | none | Signature name |
roles | signatureCreateRoles | true | none | Signature Create Roles. |
isSerial | boolean | false | none | Is serial signature |
signatureUpdate
{
"providerId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"description": ""
}
Update Signature body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
providerId | UUID_V4 | false | none | Unique identifier for the entity |
name | string | false | none | Signature name |
description | string | false | none | Signature name |
signatureRelations
{
"provider": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"themeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"provider": ""
},
"roles": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"roleId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isActive": true,
"sequence": 0,
"sendSignedFile": true,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
}
Signature included relations
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
provider | signatureProvider | false | none | Related Signature Provider |
roles | array | false | none | Related Signature Roles. It should be defined and have at least 1 role |
signatureFindByIdResponse
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isSerial": false,
"methods": [
"string"
],
"defaultMethod": "string",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"providerId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"description": "",
"provider": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"themeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"provider": ""
},
"roles": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"roleId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isActive": true,
"sequence": 0,
"sendSignedFile": true,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
}
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | signature | false | none | Signature |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | signatureRelations | false | none | Signature included relations |
signatureFindResponse
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isSerial": false,
"methods": [
"string"
],
"defaultMethod": "string",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"providerId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"description": "",
"provider": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"themeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"provider": ""
},
"roles": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"roleId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isActive": true,
"sequence": 0,
"sendSignedFile": true,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
}
]
Signature Collection
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | signature | false | none | Signature |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | signatureRelations | false | none | Signature included relations |
signatureRole
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"roleId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isActive": true,
"sequence": 0,
"sendSignedFile": true,
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Signature Role
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | false | none | Unique identifier for the entity |
signatureId | UUID_V4 | false | none | Unique identifier for the entity |
roleId | UUID_V4 | false | none | Unique identifier for the entity |
isActive | boolean | false | none | Is active signature role |
sequence | number | false | none | none |
sendSignedFile | boolean | false | none | It is needed only for 'candidate' role to send signed file over the email sending |
createdAt | DateISO | false | none | Datetime in ISO format |
updatedAt | DateISO | false | none | Datetime in ISO format |
signatureProviderBase
{
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"themeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"provider": ""
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
companyId | UUID_V4 | false | none | Unique identifier for the entity |
themeId | UUID_V4 | false | none | Unique identifier for the entity |
name | string | false | none | Signature provider name |
provider | string | false | none | Signature provider |
signatureProvider
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"themeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"provider": ""
}
Signature provider
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | object | false | none | none |
» id | UUID_V4 | false | none | Unique identifier for the entity |
» createdAt | DateISO | false | none | Datetime in ISO format |
» updatedAt | DateISO | false | none | Datetime in ISO format |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | signatureProviderBase | false | none | none |
signatureProviderCreate
{
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"themeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"provider": ""
}
Create Signature provider body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
companyId | UUID_V4 | true | none | Unique identifier for the entity |
themeId | UUID_V4 | true | none | Unique identifier for the entity |
name | string | true | none | Signature provider name |
provider | string | true | none | Signature provider |
signatureProviderUpdate
{
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"themeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"provider": ""
}
Update Signature provider body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
companyId | UUID_V4 | false | none | Unique identifier for the entity |
themeId | UUID_V4 | false | none | Unique identifier for the entity |
name | string | false | none | Signature provider name |
provider | string | false | none | Signature provider |
signatureProviderRelations
{}
Signature provider included relations
Properties
None
signatureProviderFindResponse
[
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"themeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"provider": ""
}
]
Signature Provider Collection
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | signatureProvider | false | none | Signature provider |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | signatureProviderRelations | false | none | Signature provider included relations |
signatureProviderFindByIdResponse
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"themeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"provider": ""
}
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | signatureProvider | false | none | Signature provider |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | signatureProviderRelations | false | none | Signature provider included relations |
signatureRequestEntity
"form"
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | none |
Enumerated Values
Property | Value |
---|---|
anonymous | form |
signatureRequestStatus
"open"
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | none |
Enumerated Values
Property | Value |
---|---|
anonymous | open |
anonymous | pending |
anonymous | signed |
anonymous | canceled |
signatureRequestBase
{
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"entity": "form",
"entityId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"externalSignatureRequestId": "",
"fileKey": "",
"signedFileKey": "",
"signedFileName": "",
"status": "open",
"isSerial": false,
"methods": [
"string"
],
"defaultMethod": "string"
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
signatureId | UUID_V4 | false | none | Unique identifier for the entity |
entity | signatureRequestEntity | false | none | none |
entityId | UUID_V4 | false | none | Unique identifier for the entity |
externalSignatureRequestId | string | false | none | Signature Request external id |
fileKey | string | false | none | Signature request file key |
signedFileKey | string | false | none | Signature request signed file key |
signedFileName | string | false | none | Signature request signed file name |
status | signatureRequestStatus | false | none | none |
isSerial | boolean | false | none | Is serial signature request |
methods | signatureMethods | false | none | The list of available signature methods for signers |
defaultMethod | signatureMethod | false | none | Signature method that is available for signers |
signatureRequest
{
"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",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"entity": "form",
"entityId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"externalSignatureRequestId": "",
"fileKey": "",
"signedFileKey": "",
"signedFileName": "",
"status": "open",
"isSerial": false,
"methods": [
"string"
],
"defaultMethod": "string"
}
Signature request
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | object | false | none | none |
» id | UUID_V4 | false | none | Unique identifier for the entity |
» companyId | UUID_V4 | false | none | Unique identifier for the entity |
» createdAt | DateISO | false | none | Datetime in ISO format |
» updatedAt | DateISO | false | none | Datetime in ISO format |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | signatureRequestBase | false | none | none |
signatureRequestCreate
{
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"entity": "form",
"entityId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"externalSignatureRequestId": "",
"fileKey": "",
"signedFileKey": "",
"signedFileName": "",
"status": "open",
"isSerial": false,
"methods": [
"string"
],
"defaultMethod": "string"
}
Create Signature request body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
signatureId | UUID_V4 | false | none | Unique identifier for the entity |
entity | signatureRequestEntity | false | none | none |
entityId | UUID_V4 | false | none | Unique identifier for the entity |
externalSignatureRequestId | string | false | none | Signature Request external id |
fileKey | string | false | none | Signature request file key |
signedFileKey | string | false | none | Signature request signed file key |
signedFileName | string | false | none | Signature request signed file name |
status | signatureRequestStatus | false | none | none |
isSerial | boolean | false | none | Is serial signature request |
methods | signatureMethods | false | none | The list of available signature methods for signers |
defaultMethod | signatureMethod | false | none | Signature method that is available for signers |
signatureRequestUpdate
{
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"entity": "form",
"entityId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"externalSignatureRequestId": "",
"fileKey": "",
"signedFileKey": "",
"signedFileName": "",
"status": "open",
"isSerial": false,
"methods": [
"string"
],
"defaultMethod": "string"
}
Update Signature request body params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
signatureId | UUID_V4 | false | none | Unique identifier for the entity |
entity | signatureRequestEntity | false | none | none |
entityId | UUID_V4 | false | none | Unique identifier for the entity |
externalSignatureRequestId | string | false | none | Signature Request external id |
fileKey | string | false | none | Signature request file key |
signedFileKey | string | false | none | Signature request signed file key |
signedFileName | string | false | none | Signature request signed file name |
status | signatureRequestStatus | false | none | none |
isSerial | boolean | false | none | Is serial signature request |
methods | signatureMethods | false | none | The list of available signature methods for signers |
defaultMethod | signatureMethod | false | none | Signature method that is available for signers |
signatureRequestRelations
{
"company": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it",
"pl",
"ro",
"sq",
"be",
"bg",
"hr",
"cs",
"da",
"et",
"fi",
"el",
"hu",
"is",
"ga",
"lv",
"lt",
"mk",
"mt",
"no",
"pt",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"uk",
"cy"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
},
"signature": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isSerial": false,
"methods": [
"string"
],
"defaultMethod": "string",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"providerId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"description": ""
},
"candidateForm": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Initial",
"folder": "Registration",
"actions": [
"complete",
"download"
],
"completedActions": [
"complete",
"download"
],
"isLocked": false,
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"isPdfGenerationEnabled": false,
"pdfFilePath": "pdf/file/path",
"pdfFileName": "string",
"remotePdfFilePath": "string",
"status": "requested",
"type": "editable",
"isAddition": false,
"parentId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"metadata": {},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"candidateResource": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Manager's contract",
"locked": false,
"text": "<p>It's the contract.</p>",
"completedActions": [
"complete",
"download"
],
"file": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"filename": "Contract J.J. Mask.pdf",
"remoteFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFilename": "Contract_example.pdf",
"fields": [
{
"reference": "Mask",
"value": {
"checkbox": false,
"text": "Mask",
"email": "Mask",
"signature": "data:image/png;base64,iVBORw0KGg"
}
}
],
"status": "requested",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies"
},
"candidateDocumentType": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"internal": false,
"folder": "string",
"customStatus": "pending",
"ocrParsedData": {},
"validationSnapshot": {
"total": 10,
"totalToBePending": 10,
"conditions": [
{
"type": "or",
"action": "score",
"score": 10,
"sequence": 1,
"isValid": true,
"validations": [
{
"rule": "string",
"method": "contains",
"value": {
"value": "value"
},
"fieldName": "firstName",
"fieldValue": "Field value",
"sequence": 1,
"isValid": true
}
]
}
]
},
"integrationTransferedAt": "string",
"mergeSetFilePath": "string",
"isMultiple": false,
"isProcessing": false,
"isPaused": false,
"combinedMultipleDocumentPath": "string",
"combinedMultipleDocumentName": "string",
"expiresOn": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false
},
"signers": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureRequestId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureRoleId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signerId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"externalSignerId": "",
"isSigned": true,
"sequence": 0,
"isNext": true,
"signedFileKey": "",
"sendSignedFile": true,
"token": "",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
}
Signature request included relations
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
company | company | false | none | Related Company |
signature | signature | false | none | Related Signature |
candidateForm | candidateForm | false | none | Related Candidate Form |
candidateResource | candidateResource | false | none | Related Candidate Resource |
candidateDocumentType | candidateDocumentType | false | none | Related Candidate Document Type |
signers | array | false | none | Related Signature Request Signers |
signatureRequestFindResponse
[
{
"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",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"entity": "form",
"entityId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"externalSignatureRequestId": "",
"fileKey": "",
"signedFileKey": "",
"signedFileName": "",
"status": "open",
"isSerial": false,
"methods": [
"string"
],
"defaultMethod": "string",
"company": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it",
"pl",
"ro",
"sq",
"be",
"bg",
"hr",
"cs",
"da",
"et",
"fi",
"el",
"hu",
"is",
"ga",
"lv",
"lt",
"mk",
"mt",
"no",
"pt",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"uk",
"cy"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
},
"signature": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isSerial": false,
"methods": [
"string"
],
"defaultMethod": "string",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"providerId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"description": ""
},
"candidateForm": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Initial",
"folder": "Registration",
"actions": [
"complete",
"download"
],
"completedActions": [
"complete",
"download"
],
"isLocked": false,
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"isPdfGenerationEnabled": false,
"pdfFilePath": "pdf/file/path",
"pdfFileName": "string",
"remotePdfFilePath": "string",
"status": "requested",
"type": "editable",
"isAddition": false,
"parentId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"metadata": {},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"candidateResource": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Manager's contract",
"locked": false,
"text": "<p>It's the contract.</p>",
"completedActions": [
"complete",
"download"
],
"file": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"filename": "Contract J.J. Mask.pdf",
"remoteFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFilename": "Contract_example.pdf",
"fields": [
{
"reference": "Mask",
"value": {
"checkbox": false,
"text": "Mask",
"email": "Mask",
"signature": "data:image/png;base64,iVBORw0KGg"
}
}
],
"status": "requested",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies"
},
"candidateDocumentType": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"internal": false,
"folder": "string",
"customStatus": "pending",
"ocrParsedData": {},
"validationSnapshot": {
"total": 10,
"totalToBePending": 10,
"conditions": [
{
"type": "or",
"action": "score",
"score": 10,
"sequence": 1,
"isValid": true,
"validations": [
{
"rule": "string",
"method": "contains",
"value": {
"value": "value"
},
"fieldName": "firstName",
"fieldValue": "Field value",
"sequence": 1,
"isValid": true
}
]
}
]
},
"integrationTransferedAt": "string",
"mergeSetFilePath": "string",
"isMultiple": false,
"isProcessing": false,
"isPaused": false,
"combinedMultipleDocumentPath": "string",
"combinedMultipleDocumentName": "string",
"expiresOn": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false
},
"signers": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureRequestId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureRoleId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signerId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"externalSignerId": "",
"isSigned": true,
"sequence": 0,
"isNext": true,
"signedFileKey": "",
"sendSignedFile": true,
"token": "",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
}
]
Signature Request Collection
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | signatureRequest | false | none | Signature request |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | signatureRequestRelations | false | none | Signature request included relations |
signatureRequestFindByIdResponse
{
"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",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"entity": "form",
"entityId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"externalSignatureRequestId": "",
"fileKey": "",
"signedFileKey": "",
"signedFileName": "",
"status": "open",
"isSerial": false,
"methods": [
"string"
],
"defaultMethod": "string",
"company": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"zipAllCandidateDocumentsFileName": "zip_{candidateLastname}_{candidateFirstname}",
"replyToEmail": "[email protected]",
"archiveInactiveCandidateAfterDays": 7,
"deleteInactiveCandidateAfterDays": 7,
"logo": "",
"languages": [
"en",
"fr",
"nl",
"de",
"it",
"pl",
"ro",
"sq",
"be",
"bg",
"hr",
"cs",
"da",
"et",
"fi",
"el",
"hu",
"is",
"ga",
"lv",
"lt",
"mk",
"mt",
"no",
"pt",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"uk",
"cy"
],
"fileBoxCss": ".custom {color: red;}",
"largeDocumentThumbnail": false,
"isMultipleUploadEnabled": true,
"maxNumberOfFilesPerDocument": 20,
"isCandidateConversationEnabled": false,
"locale": {
"key": "Belgium_nl",
"country": "Belgium",
"lang": "nl",
"dateFormat": "D/MM/YYYY",
"code": "BE",
"phoneCode": "32"
}
},
"signature": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"isSerial": false,
"methods": [
"string"
],
"defaultMethod": "string",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"providerId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "",
"description": ""
},
"candidateForm": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"formId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"fileId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Initial",
"folder": "Registration",
"actions": [
"complete",
"download"
],
"completedActions": [
"complete",
"download"
],
"isLocked": false,
"isMandatory": false,
"isPreliminary": false,
"isBlocking": false,
"filename": "initial_{candidateFirstname}",
"isPdfGenerationEnabled": false,
"pdfFilePath": "pdf/file/path",
"pdfFileName": "string",
"remotePdfFilePath": "string",
"status": "requested",
"type": "editable",
"isAddition": false,
"parentId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"metadata": {},
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
},
"candidateResource": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"companyId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"accountId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "Manager's contract",
"locked": false,
"text": "<p>It's the contract.</p>",
"completedActions": [
"complete",
"download"
],
"file": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"filename": "Contract J.J. Mask.pdf",
"remoteFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFile": "5fdb302e1dae4f02c9933cda/resources/5fe1f37f7d6ebb05b9b0f09b.pdf",
"attachedFilename": "Contract_example.pdf",
"fields": [
{
"reference": "Mask",
"value": {
"checkbox": false,
"text": "Mask",
"email": "Mask",
"signature": "data:image/png;base64,iVBORw0KGg"
}
}
],
"status": "requested",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"resourceId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"actions": [
"complete",
"download"
],
"blocking": false,
"folder": "Policies"
},
"candidateDocumentType": {
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"documentTypeId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"candidateId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"name": "ASAP",
"description": "Description of the document type",
"internal": false,
"folder": "string",
"customStatus": "pending",
"ocrParsedData": {},
"validationSnapshot": {
"total": 10,
"totalToBePending": 10,
"conditions": [
{
"type": "or",
"action": "score",
"score": 10,
"sequence": 1,
"isValid": true,
"validations": [
{
"rule": "string",
"method": "contains",
"value": {
"value": "value"
},
"fieldName": "firstName",
"fieldValue": "Field value",
"sequence": 1,
"isValid": true
}
]
}
]
},
"integrationTransferedAt": "string",
"mergeSetFilePath": "string",
"isMultiple": false,
"isProcessing": false,
"isPaused": false,
"combinedMultipleDocumentPath": "string",
"combinedMultipleDocumentName": "string",
"expiresOn": "2019-09-12T15:36:09.264Z",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z",
"filename": "file_of_the_company_candidate_{candidateFirstname}",
"comment": "string",
"commentType": "info",
"mandatory": false
},
"signers": [
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureRequestId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureRoleId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signerId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"externalSignerId": "",
"isSigned": true,
"sequence": 0,
"isNext": true,
"signedFileKey": "",
"sendSignedFile": true,
"token": "",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
]
}
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | signatureRequest | false | none | Signature request |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | signatureRequestRelations | false | none | Signature request included relations |
signatureRequestGetSignAsAdminLinkResponse
{
"signUrl": "string",
"clientId": "string"
}
Sign as admin user link params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
signUrl | string | false | none | Sign admin user link |
clientId | string | false | none | Sign client id |
signatureRequestGetSignAsCandidateLinkResponse
{
"signUrl": "string",
"clientId": "string"
}
Sign as candidate link params
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
signUrl | string | false | none | Sign candidate link |
clientId | string | false | none | Sign client id |
signatureRequestSigner
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureRequestId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signatureRoleId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"signerId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"externalSignerId": "",
"isSigned": true,
"sequence": 0,
"isNext": true,
"signedFileKey": "",
"sendSignedFile": true,
"token": "",
"createdAt": "2019-09-12T15:36:09.264Z",
"updatedAt": "2019-09-12T15:36:09.264Z"
}
Signature Request Signer
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | false | none | Unique identifier for the entity |
signatureRequestId | UUID_V4 | false | none | Unique identifier for the entity |
signatureRoleId | UUID_V4 | false | none | Unique identifier for the entity |
signerId | UUID_V4 | false | none | Unique identifier for the entity |
externalSignerId | string | false | none | External signer id |
isSigned | boolean | false | none | It says that the signature request is signed by signer |
sequence | number | false | none | none |
isNext | boolean | false | none | It says that the signer is next to sign a document |
signedFileKey | string | false | none | Signed file key |
sendSignedFile | boolean | false | none | It is needed only for 'candidate' signer to send signed file over the email sending |
token | string | false | none | Signer token |
createdAt | DateISO | false | none | Datetime in ISO format |
updatedAt | DateISO | false | none | Datetime in ISO format |
tag
{
"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"
}
Tag for grouping data based on similarity
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | true | none | Unique identifier for the entity |
companyId | UUID_V4 | true | none | Unique identifier for the entity |
name | string | true | none | Tag name |
color | string | false | none | Tag color |
createdAt | DateISO | true | none | Datetime in ISO format |
updatedAt | DateISO | true | none | Datetime in ISO format |
tagCount
{
"total": 0
}
The total number of tags matching the query.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
total | number | true | none | none |
tagArray
[
{
"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"
}
]
Array of tags
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [tag] | false | none | Array of tags |
tagCreate
{
"name": "ASAP",
"color": "#F09E38"
}
Create a new tag
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
name | string | true | none | Tag name |
color | string | false | none | Tag color |
tagUpdate
{
"name": "ASAP",
"color": "#F09E38"
}
Update existed tag
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
name | string | true | none | Tag name |
color | string | false | none | Tag color |
tagFind
[
{
"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
}
}
]
Properties
oneOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | tagWithStatisticArray | false | none | Array of tags with statistics |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | tagArray | false | none | Array of tags |
tagValidate
{
"uniq": true
}
Does the tag exist in the company
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
uniq | boolean | false | none | Is this a unique name for the tag within the company |
tagWithStatistic
{
"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
}
}
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | tag | false | none | Tag for grouping data based on similarity |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | object | false | none | Tag usage statistics across different entities. |
» statistic | tagStatistic | false | none | Tag usage statistics across different entities. |
tagWithStatisticArray
[
{
"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
}
}
]
Array of tags with statistics
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [tagWithStatistic] | false | none | Array of tags with statistics |
tagStatistic
{
"id": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"tagId": "d3ccc75a-7f76-41f8-9ddf-c61622c8e091",
"scenarios": 3,
"candidates": 12
}
Tag usage statistics across different entities.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | UUID_V4 | true | none | Unique identifier for the entity |
tagId | UUID_V4 | true | none | Unique identifier for the entity |
scenarios | number | true | none | Number of scenarios with this tag |
candidates | number | true | none | Number of candidates with this tag |
template
{
"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": "ASAP",
"type": "email",
"email": {
"editor": "tinymce",
"subject": "Welcome to Tesla!",
"content": "<div>Welcome to Tesla! </div><div>Here is your link for adding documents: `{link}`</div>",
"design": {},
"css": ".welcome {\n font-size: 25px;\n}"
},
"sms": {
"content": "Welcome to Tesla!\n Here is your link for adding documents: ..."
}
}
Manager for sending scenario. Available methods: email
and sms
.
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | object | false | none | none |
» id | UUID_V4 | false | none | Unique identifier for the entity |
» companyId | UUID_V4 | false | none | Unique identifier for the entity |
» createdAt | DateISO | false | none | Datetime in ISO format |
» updatedAt | DateISO | false | none | Datetime in ISO format |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | templateBase | false | none | Template base fields |
templateArray
[
{
"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": "ASAP",
"type": "email",
"email": {
"editor": "tinymce",
"subject": "Welcome to Tesla!",
"content": "<div>Welcome to Tesla! </div><div>Here is your link for adding documents: `{link}`</div>",
"design": {},
"css": ".welcome {\n font-size: 25px;\n}"
},
"sms": {
"content": "Welcome to Tesla!\n Here is your link for adding documents: ..."
}
}
]
Array of templates
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [template] | false | none | Array of templates |
templateCreate
{
"name": "ASAP",
"type": "email",
"email": {
"editor": "tinymce",
"subject": "Welcome to Tesla!",
"content": "<div>Welcome to Tesla! </div><div>Here is your link for adding documents: `{link}`</div>",
"design": {},
"css": ".welcome {\n font-size: 25px;\n}"
},
"sms": {
"content": "Welcome to Tesla!\n Here is your link for adding documents: ..."
}
}
Template base fields
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
name | string | true | none | Template name |
type | string | false | none | Template type |
templateEmail | false | none | Template email | |
sms | templateSms | false | none | Template SMS |
Enumerated Values
Property | Value |
---|---|
type | email_sms |
type | |
type | sms |
templateEmail
{
"editor": "tinymce",
"subject": "Welcome to Tesla!",
"content": "<div>Welcome to Tesla! </div><div>Here is your link for adding documents: `{link}`</div>",
"design": {},
"css": ".welcome {\n font-size: 25px;\n}"
}
Template email
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
editor | string | false | none | Email editor type (keep empty if you use API only) |
subject | string | false | none | Email subject |
content | string(html) | false | none | Email body. |
design | object | false | none | The json configuration of the template content |
css | string(css) | false | none | Styles that will be applied to the body of the email. |
Enumerated Values
Property | Value |
---|---|
editor | tinymce |
editor | unlayer |
templateBase
{
"name": "ASAP",
"type": "email",
"email": {
"editor": "tinymce",
"subject": "Welcome to Tesla!",
"content": "<div>Welcome to Tesla! </div><div>Here is your link for adding documents: `{link}`</div>",
"design": {},
"css": ".welcome {\n font-size: 25px;\n}"
},
"sms": {
"content": "Welcome to Tesla!\n Here is your link for adding documents: ..."
}
}
Template base fields
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
name | string | false | none | Template name |
type | string | false | none | Template type |
templateEmail | false | none | Template email | |
sms | templateSms | false | none | Template SMS |
Enumerated Values
Property | Value |
---|---|
type | email_sms |
type | |
type | sms |
templateSms
{
"content": "Welcome to Tesla!\n Here is your link for adding documents: ..."
}
Template SMS
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
content | string | false | none | The content of the sms message that the candidate will receive if certain conditions are met. To validate content, please use the method: /validate-sms-content {link} to the candidate's profile at the end of the message will be added automatically. |
templateUpdate
{
"name": "ASAP",
"type": "email",
"email": {
"editor": "tinymce",
"subject": "Welcome to Tesla!",
"content": "<div>Welcome to Tesla! </div><div>Here is your link for adding documents: `{link}`</div>",
"design": {},
"css": ".welcome {\n font-size: 25px;\n}"
},
"sms": {
"content": "Welcome to Tesla!\n Here is your link for adding documents: ..."
}
}
Template base fields
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
name | string | false | none | Template name |
type | string | false | none | Template type |
templateEmail | false | none | Template email | |
sms | templateSms | false | none | Template SMS |
Enumerated Values
Property | Value |
---|---|
type | email_sms |
type | |
type | sms |
templateValidateSmsContent
{
"content": "Welcome to Tesla!\n Here is your link for adding documents: ..."
}
Properties
None
templateValidateSmsContentResponse
{
"partChars": 160,
"isValid": true,
"maxPartsAmount": 8,
"partsAmount": 7,
"charsLeft": 122,
"maxChars": 1224
}
SMS content validation data.
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
partChars | number | false | none | The maximum number of characters available in one part. |
isValid | boolean | false | none | Is SMS content valid |
maxPartsAmount | number | false | none | Maximum possible number of SMS parts. |
partsAmount | number | false | none | How many parts are still available for SMS. |
charsLeft | number | false | none | How many characters are still available in the current part of the message. |
maxChars | number | false | none | The total number of characters allowed in all parts. |