You are viewing a section of Superface that will be deprecated in Q4 2023. Until then, you can continue to use it as you have before but we recommend that you migrate to our latest version soon. For more details visit superface.ai/docs/migrate.
Manage Candidates
recruitment/candidates@1.0.12 providers
Create Candidate
Creates an application for specific job. The candidate may (depends on the provider implementation) receive notification that her/his application was successfully accepted by the company.
Input
Job Id
First Name
Last Name
Email
Phone
Address
Education
Work Experience
CV (Resume)
Links
Answers
Stage Id
Result
Id
Job Id
Rate limit
1.Choose a provider
2.Use CreateCandidate with mock in your code
Below instructions are for our Node.js SDK. Use OneService for other languages.
npm i @superfaceai/one-sdk
Structure details
Input (object)
jobId
required
Id of a job, to which candidate applies to.
string
firstName
required
First name of a candidate.
string
lastName
required
Last name of a candidate.
string
email
required
Email of a candidate.
string
phone
optional
Phone number of a candidate.
string
address
optional
Address of a candidate.
string
education
optional
Array of education experiences.
list
id
optional
Unique identifier of candidate's education experience.
string
school
optional
Name of a school.
string
degree
optional
Degree aquired by finishing candidate's education.
string
fieldOfStudy
optional
Name of a field studied in candidate's education.
string
startedAt
optional
ISO8601 timestamp when the education started.
string
endedAt
optional
ISO8601 timestamp when the education ended.
string
workExperience
optional
Array of work experiences.
list
id
optional
Unique identifier of candidate's work experience.
string
position
optional
Name of position, candidate has occupied.
string
summary
optional
Summary of candidate's work experience.
string
company
optional
Name of company.
string
industry
optional
Name of industry, the company worked in.
string
current
optional
Boolean representing whether candidate still work there.
boolean
startedAt
optional
ISO8601 timestamp when candidate started working.
string
endedAt
optional
ISO8601 timestamp when candidate stoped working.
string
cv
optional
Object containing either URL to a CV or data encoded in Base64 format with CV document and name with the file name.
links
optional
Array of links to different profiles or portfolios of a candidate.
list
name
optional
Descriptive name of a link to some URL.
string
url
optional
Actual URL destination of the link.
string
answers
optional
Array of answers to questions connected to a job that candidate applies to.
list
questionId
optional
Unique identifier of a question for this answer.
string
type
optional
Enum representing type of possible answer.
enum
texttextareanumberbooleanmultiple_choicemultiple_selectdatefile
value
optional
Value of an answer, is dependent on type of an answer.
stageId
optional
Unique identifier of a stage, in which candidate is in.
string
Example
Result (object)
id
required
Unique identifier of newly created candidate.
string
jobId
required
Unique identifier of a job, newly created candidate applied for.
string
rateLimit
optional
Rate limit details.
object
bucket
optional
Different parts of API may have different rate limits.
Bucket identifies to which part of API the rate limits apply.
string
totalRequests
optional
Total requests available in the time window.
number
remainingRequests
optional
Remaining requests available in the time window.
number
remainingRequestsPercentage
optional
Remaining requests available in the time window in percents.
number
resetTimestamp
optional
Timestamp when the rate limits will reset (in Unix Timestamp format). Available only for providers without rolling rate limit window.
number