Superface

Manage Candidates

recruitment/candidates@1.0.1
2 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
const { SuperfaceClient } = require('@superfaceai/one-sdk');

// You can manage tokens here: https://superface.ai/insights
const sdk = new SuperfaceClient({ sdkAuthToken: '<< Login to get your token >>' });

async function run() {
  // Load the profile
  const profile = await sdk.getProfile('recruitment/candidates@1.0.1');

  // Use the profile
  const result = await profile
    .getUseCase('CreateCandidate')
    .perform({
      jobId: 'JOB_ID',
      firstName: 'Demo',
      lastName: 'Testing',
      email: 'demo_testing@fakemail.com'
    }, {
      provider: 'mock'
    });

  // Handle the result
  try {
    const data = result.unwrap();
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

run();

Structure details

Input (object)

jobId
Id of a job, to which candidate applies to.
firstName
First name of a candidate.
lastName
Last name of a candidate.
email
Email of a candidate.
phone
Phone number of a candidate.
address
Address of a candidate.
education
Array of education experiences.
id
Unique identifier of candidate's education experience.
school
Name of a school.
degree
Degree aquired by finishing candidate's education.
fieldOfStudy
Name of a field studied in candidate's education.
startedAt
ISO8601 timestamp when the education started.
endedAt
ISO8601 timestamp when the education ended.
workExperience
Array of work experiences.
id
Unique identifier of candidate's work experience.
position
Name of position, candidate has occupied.
summary
Summary of candidate's work experience.
company
Name of company.
industry
Name of industry, the company worked in.
current
Boolean representing whether candidate still work there.
startedAt
ISO8601 timestamp when candidate started working.
endedAt
ISO8601 timestamp when candidate stoped working.
cv
Object containing either URL to a CV or data encoded in Base64 format with CV document and name with the file name.
links
Array of links to different profiles or portfolios of a candidate.
name
Descriptive name of a link to some URL.
url
Actual URL destination of the link.
answers
Array of answers to questions connected to a job that candidate applies to.
questionId
Unique identifier of a question for this answer.
type
Enum representing type of possible answer.
value
Value of an answer, is dependent on type of an answer.
stageId
Unique identifier of a stage, in which candidate is in.

Example

{
  "jobId": "JOB_ID",
  "firstName": "Demo",
  "lastName": "Testing",
  "email": "demo_testing@fakemail.com"
}

Result (object)

id
Unique identifier of newly created candidate.
jobId
Unique identifier of a job, newly created candidate applied for.
rateLimit
Rate limit details.
bucket
Different parts of API may have different rate limits. Bucket identifies to which part of API the rate limits apply.
totalRequests
Total requests available in the time window.
remainingRequests
Remaining requests available in the time window.
remainingRequestsPercentage
Remaining requests available in the time window in percents.
resetTimestamp
Timestamp when the rate limits will reset (in Unix Timestamp format). Available only for providers without rolling rate limit window.

Example

{
  "id": "CANDIDATE_ID",
  "jobId": "JOB_ID"
}

Implementation details

Provider
mock
Use case
CreateCandidate
Author
@superface
Source
View source
Verified