# Create candidate Creates a Candidate with associated checks. Endpoint: POST /candidates Version: 1.0.0 Security: bearerAuth ## Request fields (application/json): - `candidate` (object, required) - `candidate.first_name` (string) Example: "Luke" - `candidate.last_name` (string) Example: "Skywalker" - `candidate.email` (string) Example: "luke.skywalker@email.com" - `candidate.contact_number` (string) Example: "+6493614595" - `candidate.job_role` (string) Example: "Padawan" - `candidate.department` (string) Example: "Jedis" - `candidate.partner_application_id` (string) Example: "your_unique_id" - `candidate.partner_application_started` (boolean) Example: true - `checks` (array) - `checks.type` (string) Check code Example: "reference" - `checks.details` (object) Details from Get Check Type Details - `checks.renewal` (boolean) Example: true - `bundle_id` (integer,null) If given, checks value will be ignored - `bypass` (boolean) If true, candidate won't be contacted - `user_email` (string) Match with existing company user as owner Example: "user@company.com" ## Response 200 fields (application/json): - `result` (object) - `result.id` (integer) Example: 1 - `result.reference_code` (string) Example: "whatever" - `result.first_name` (string) Example: "Luke" - `result.last_name` (string) Example: "Skywalker" - `result.name` (string) Example: "Luke Skywalker" - `result.email` (string) Example: "luke.skywalker@email.com" - `result.contact_number` (string) Example: "+6493614595" - `result.job_role` (string) Example: "Padawan" - `result.department` (string) Example: "Jedis" - `result.ip` (string,null) - `result.status` (string) Enum: "candidate", "submitted", "in-progress", "completed", "overdue", "canceled" - `result.token` (string) Example: "https://app.checkmate.tech/assessments/details/12/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1N..." - `result.created_at` (string) Example: "2021-06-27T10:05:13+02:00" - `result.submitted_at` (string,null) - `result.completed_at` (string,null) - `result.accepted_terms_and_conditions` (boolean) - `result.partner_application_id` (string) Example: "your_unique_id" - `result.partner_application_started` (boolean) Example: true - `result.cc_notification_emails` (string) - `result.partner_link` (string) Example: "https://app.checkmate.tech/assessments/details/12/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1N..." - `result.candidate_checks` (array) - `result.candidate_checks.type` (string) Example: "acc" - `result.candidate_checks.job_at` (string,null) - `result.candidate_checks.details` (object,null) - `result.candidate_checks.accepted_terms` (boolean) - `result.candidate_checks.result_flag` (boolean) - `result.candidate_checks.renewal` (boolean) - `result.candidate_checks.user_agent` (string,null) - `result.candidate_checks.upload` (object) - `result.candidate_checks.upload.file_name` (string) Example: "dummy_result.pdf" - `result.candidate_checks.upload.file_type` (string) Example: "application/pdf" - `result.candidate_checks.upload.url` (string) Expires after 20 minutes; refreshes on each request Example: "https://checkmate-staging.s3.ap-southeast-2.amazonaws.com/backg..." - `result.candidate_checks.expiration_date` (string,null) Example: "2024-10-23" - `result.candidate_checks_values` (object) - `result.candidate_checks_values.values` (object) - `error` (object,null)