Candidate Add
This API is to add candidate. This is an authendicated API so we need to pass bearer token in request header to access the data.
Body
-
First Name
-
Last Name
-
Email
-
Send Login details to email
-
Profile View
-
Address line 1
-
Place
-
Postal Code
-
Preferred Name
-
Employment Type ID
-
Employment Type Company ID
-
DBS/PVG No
-
DBS/PVG Issue Date
-
DBS/PVG Expiry Date
-
Next Check Date
-
NMC/NISCC/SSSC Pin
-
Nationality
-
Date of Birth
-
Place of Birth
-
Gender
Values are
male
,female
, orother
. -
Start Date
-
End Date
-
Driver
-
NAPPI Trained
-
Medication Trained
-
Weekly Working Hours
Minimum value is
1
, maximum value is168
. -
PAYROLL NI Number
-
PAYROLL Tax Code
-
Payroll ID
-
Payroll Status
Values are
nil
,First Job 6th April
,I have another job
,Student Loan
, orThis is my only job
. -
Payroll Frequency
Values are
Weekly
,Monthly
, or4 Weekly
. -
Payment Reference
curl \
--request POST 'https://api-console.logezy.co/v1/candidate' \
--header "Content-Type: string" \
--header "Accept: string" \
--data '{"first_name":"string","last_name":"string","email":"string","send_email":true,"has_contact_profile_view":true,"address_line1":"string","place":"string","post_code":"string","mobile_prefix":"string","mobile_number":"string","preferred_name":"string","employment_type":42,"employment_type_company_id":42,"dbs_pvg_no":"string","dbs_issue_date":"2023-11-01","dbs_exp_date":"2023-11-01","next_check_date":"2023-11-01","nmc_pin_number":"string","nationality":"string","dob":"2021-04-13","place_of_birth":"string","gender":"male","start_date":"2025-05-04","end_date":"2025-05-04","is_driver":true,"nappi_trained":true,"medication_trained":true,"weekly_hours":42.0,"selected_profile_job":[42],"jobs":[42],"regions":[42],"ni_number":"string","tax_code":"string","payroll_id":"string","payroll_job_status":"nil","payroll_frequency":"Weekly","payment_reference":"string"}'
# Headers
Content-Type: string
Accept: string
# Payload
{
"first_name": "string",
"last_name": "string",
"email": "string",
"send_email": true,
"has_contact_profile_view": true,
"address_line1": "string",
"place": "string",
"post_code": "string",
"mobile_prefix": "string",
"mobile_number": "string",
"preferred_name": "string",
"employment_type": 42,
"employment_type_company_id": 42,
"dbs_pvg_no": "string",
"dbs_issue_date": "2023-11-01",
"dbs_exp_date": "2023-11-01",
"next_check_date": "2023-11-01",
"nmc_pin_number": "string",
"nationality": "string",
"dob": "2021-04-13",
"place_of_birth": "string",
"gender": "male",
"start_date": "2025-05-04",
"end_date": "2025-05-04",
"is_driver": true,
"nappi_trained": true,
"medication_trained": true,
"weekly_hours": 42.0,
"selected_profile_job": [
42
],
"jobs": [
42
],
"regions": [
42
],
"ni_number": "string",
"tax_code": "string",
"payroll_id": "string",
"payroll_job_status": "nil",
"payroll_frequency": "Weekly",
"payment_reference": "string"
}