Candidate Add

POST /candidate

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.

Headers

  • Content-Type string Required

    application/json

  • Accept string Required

    application/json

application/json

Body

  • first_name string Required

    First Name

  • last_name string Required

    Last Name

  • email string Required

    Email

  • send_email boolean Required

    Send Login details to email

  • has_contact_profile_view boolean

    Profile View

  • address_line1 string

    Address line 1

  • place string

    Place

  • post_code string

    Postal Code

  • mobile_prefix string Required
  • mobile_number string Required
  • preferred_name string

    Preferred Name

  • employment_type integer Required

    Employment Type ID

  • employment_type_company_id integer

    Employment Type Company ID

  • dbs_pvg_no string

    DBS/PVG No

  • dbs_issue_date string(date)

    DBS/PVG Issue Date

  • dbs_exp_date string(date)

    DBS/PVG Expiry Date

  • next_check_date string(date)

    Next Check Date

  • nmc_pin_number string

    NMC/NISCC/SSSC Pin

  • nationality string

    Nationality

  • dob string(date)

    Date of Birth

  • place_of_birth string

    Place of Birth

  • gender string

    Gender

    Values are male, female, or other.

  • start_date string(date)

    Start Date

  • end_date string(date)

    End Date

  • is_driver boolean

    Driver

  • nappi_trained boolean

    NAPPI Trained

  • medication_trained boolean

    Medication Trained

  • weekly_hours number

    Weekly Working Hours

    Minimum value is 1, maximum value is 168.

  • selected_profile_job array[integer]
  • jobs array[integer] Required
  • regions array[integer]
  • ni_number string

    PAYROLL NI Number

  • tax_code string

    PAYROLL Tax Code

  • payroll_id string

    Payroll ID

  • payroll_job_status string

    Payroll Status

    Values are nil, First Job 6th April, I have another job, Student Loan, or This is my only job.

  • payroll_frequency string

    Payroll Frequency

    Values are Weekly, Monthly, or 4 Weekly.

  • payment_reference string

    Payment Reference

Responses

  • 200

    OK

POST /candidate
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"}'
Request examples
# 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"
}