Skip to main content

Create a candidate

POST
/partner/v1.0/standard/candidates

Creates a new candidate invitation in the Pulsifi system.


Headers​

  • Accept : application/json
  • Content-Type : application/json
  • Authorization : Bearer {access_token}


Body​

job_id string (uuid) Required
The unique identifier for the job created in the Pulsifi system.
ext_reference_id string (max 50 char) Required
External job application ID from the Applicant Tracking System (ATS).
is_anonymous_candidate nullable boolean Required
Indicates whether the candidate's details should be anonymous. If set to `true`, the `email`, `first_name`, and `last_name` fields become optional.
email nullable string (max 255 char) Required
The candidate's email address. Not required if `is_anonymous_candidate` is set to `true`.
first_name nullable string (max 255 char) Required
The candidate's first name. Not required if `is_anonymous_candidate` is set to `true`.
last_name nullable string (max 255 char) Required
The candidate's last name. Not required if `is_anonymous_candidate` is set to `true`.
deadline string (UTC Date) Optional
The assessment invitation deadline. Must be within 3 months from the current date. if not provided , the deadline will be defaulted to 3 months.
skills array object Optional
A list of skills possessed by the candidate. Max item of 15.
Child Parameters
name string (max 255 char) Required
The name of the skill.
proficiency enum Required
The level of expertise in the skill.
  • novice
  • intermediate
  • competent
  • proficient
  • expert
work_experiences array object Optional
A list of the candidate's work experiences. Max item of 10.
Child Parameters
role string (max 255 char) Required
Role title of the candidate in the organization.
organization string (max 255 char) Required
Name of the organization.
is_current boolean Required
Indicates whether the candidate is currently working at the organization.
responsibility_achievement nullable string (max 1000 char) Optional
Responsibilities and achievements of the candidate in the organization.
start_date string (YYYY-MM-DD) Required
Start date of the work experience.
end_date nullable string (YYYY-MM-DD) Optional
End date of the work experience.


Response​

200 OK.

Parameters
candidate_id string (uuid)
The unique identifier for the candidate in the Pulsifi system. This value should be stored in your database for future queries about the candidate's assessment status and results.
ext_reference_id string
The job application ID provided by an external ATS.
job_id string (uuid)
The unique identifier for the job created in the Pulsifi system.
is_anonymous_candidate boolean
Indicates whether the candidate is anonymous.
email string
The candidate's email address.
first_name string
The candidate's first name.
last_name string
The candidate's last name.
status enum (default is invited)
The status of the candidate's assessment.
  • pending
  • completed
  • failed
invitation_link string (URL)
A URL that the candidate can use to access the Pulsifi assessment.
invitation_expired_at string (UTC Date)
The expiration date and time of the invitation link.
created_at string (UTC Date)
The date and time when the invitation was created (in UTC format).
POST /partner/v1.0/standard/candidates
curl -X POST 'https://staging.api.pulsifi.me/partner/v1.0/standard/candidates' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-d '{
  "job_id": "<Pulsifi Job ID>",
  "ext_reference_id": "<ATS Reference ID>",
  "is_anonymous_candidate": false,
  "email": "johndoe@gmail.com",
  "first_name": "John",
  "last_name": "Doe",
  "deadline": "2021-08-12T12:21:59Z",
  "skills": [{
    "name": "Programming", 
    "proficiency": "novice"
  }],
  "work_experiences": [{
    "organization": "Pulsifi",
    "role": "Software Engineer",
    "is_current": true,
    "start_date": "2022-10-04",
    "end_date": "2024-10-04",
    "responsibilities_achievements": "Developing APIs."
  }]
}'
Response
{
  "candidate_id": "string",
  "ext_reference_id": "string",
  "job_id": "uuid",
  "is_anonymous_candidate": false,
  "email": "johndoe@gmail.com",
  "first_name": "John",
  "last_name": "Doe",
  "status": "invited",
  "invitation_link": "string",
  "invitation_expired_at": "2024-12-31T23:59:59Z",
  "created_at": "2024-09-02T10:30:00Z"
}