Candidate API - Overview
Today, organizations use many tools in addition to their applicant tracking system (ATS) to recruit and hire top talent. The ability to import and export candidate and application data in real time from Cornerstone’s recruiting solution to point solutions is a must for most clients. Having a reliable, easy to use externally facing candidate API will enable clients to maintain data integrity and get the most return from each point solution.
Cornerstone's Candidate APIs provide the ability to get a requisition's full application workflow, including prescreening and compliance questions, disclaimers, notes, and attachments, and then create an application and candidate in your Cornerstone portal. Applications can be posted in a complete or incomplete status. If incomplete, recruiters can invite candidates to finish their application within Cornerstones. Candidates can apply for positions through CAPI that are only on internal career sites (ICS).
Candidate API includes the following endpoints:
- Get Application Workflow - This endpoint retrieves a requisition’s full application workflow, including action items that were previously irretrievable via the legacy Job Application API like Prescreening questions, compliance questions, disclaimers, and notes.
- Post Candidate and application - This endpoint posts a candidate and application to your Cornerstone portal.
These externally facing endpoints are available for both clients and vendors to utilize. With the Candidate API (Early Adopter), the new Get Application Workflow and Post Candidate and Application endpoints enable clients to develop end-to-end integrations with recruiting solutions like chat bots, job boards, candidate relationship management solutions (CRM), marketing tools, and more.
- John Smith goes to ABC Company's Career Site to search for a Software Engineers job.
- John sees ABC offers a chat feature on their career site.
- Rather than spending time searching for a job, John engages with the chat bot regarding Engineering type roles.
- The chat provider writes to Cornerstone’s Job Requisition APIs (Get Job Requisition, Get Job Ad Details, and Get Job Requisition Custom Fields) so that they can recommend jobs to John based on job descriptions and location.
- The chat provider identifies a Software Engineering (req123) position as a great recommendation and asks if John would like to apply to this position.
- When John replies “Yes,” the chat provider calls the GET Application Workflow endpoint to request the application details for req123. Optionally, the chat provider may also check if the candidate is an internal or external candidate by calling Cornerstone’s Employee Global Search API so that they can request the correct application workflow.
- Rather than sending John to another page to complete the application, all application questions are made available for him within the chat experience, which increases ABC's chance of a successful application submission.
- After answering the last application question, John lets the chat bot know he is ready to submit his application.
- The chat provider calls the second endpoint, POST Application and Candidate, to create a new user in Cornerstone and create John's application.
- In Cornerstone, req123 has been configured previously to ensure that all new applicants go straight to the In Review status rather than the New Submission status. Req123 has also been configured to automatically assign an assessment to all applicants in the In Review status.
- Once John's application is created, he receives ABC's Apply as Guest Application Submission Email Confirmation and is automatically assigned the assessment.
- Recruiters now see that John has applied to req123 and can review his resume, contact details, and all posted application responses. Recruiters can also see that the assessment was successfully assigned.
Tip: We recommend also writing to the Get Job Requisition Custom Fields endpoint, as many clients use custom fields to specify fields unique to their organization.
- Denise goes to her favorite job board, Work4You, to search for Software Engineering jobs in her area.
- Work4You writes to Cornerstone’s Job Requisition APIs (Get Job Requisition, Get Job Ad Details, and Get Job Requisition Custom Fields) to display all jobs posted by their mutual client, ABC.
- Denise finds 10 Software Engineering roles matching her zip code.
- After reading the job details, Denise is interested in ABC's Software Engineer (req123) role and clicks Apply Now on the job board.
- Work4You calls the GET Application Workflow endpoint to populate the application, enabling Denise to apply immediately from Work4You without having to navigate to another site.
- Denise clicks Submit after uploading her resume and answering all application questions.
- The application is submitted to the Software Engineer (req123) role.
- Recruiters can see that Denise applied to Req123 and can review her resume and contact details, as well as and all applicable action items.
- Recruiters can also see that Denise's application came from Work4You.
Tip: It is recommended that you also write to the Get Job Requisition Custom Fields endpoint, as many clients use custom fields to specify fields unique to their organization.
- Sally Lee is a Recruiter at ABC Company and uses BLITZ, a candidate relationship management tool, to source and maintain relationships with candidates.
- BLITZ already writes to Cornerstone’s requisition endpoints so that recruiters can see open positions in BLITZ without having to navigate to Cornerstone.
- Sally is recruiting for their open Software Engineering (req123) position.
- While looking at her engineering talent pool in BLITZ, Sally spots Jack, a very qualified candidate for req123.
- Rather than manually downloading Jack's resume and adding Jack to req123 in her Cornerstone portal, Sally clicks Add Candidate to Requisition in BLITZ and selects req123.
- BLITZ calls the POST Application and Candidate endpoint and adds Jack and his resume to ABC Company’s Cornerstone portal.
- Sally returns to her Cornerstone portal and sees that Jack has been added to req123 but has an incomplete application.
- Sally invites Jack to apply so that he can finish the application and be considered for req123.
- It will be up to the candidate relationship management (CRM) provider (BLITZ in the above scenario) to determine at what point 1) an applicant is added to the applicant tracking system (ATS) in Cornerstone and 2) the POST Application and Candidate endpoint is called.
- The endpoint will create a candidate if the candidate does not exist and will check if the candidate exists by their email.
- If the candidate does not exist, a new candidate and application will be created.
- If an application has already been started but not completed for the specific requisition, the POST Application and Candidate endpoint may be used to complete and or replace the existing application.
See the following resources in the Cornerstone Success Center (CSC) for more information about APIs and the API Explorer:
Clients will use the Candidate API to build and maintain their own integrations with third party recruiting tools. Additional documentation is available in the API Explorer upon release of the Candidate API. See Edge - API Explorer.
The following permissions apply to this functionality:
|PERMISSION NAME||PERMISSION DESCRIPTION||CATEGORY|
|Edge Integrations - Manage||Grants access to the Integrations service for Edge Integrate where the administrator can configure, enable, and disable their third-party integrations that are used within the Cornerstone system. This permission cannot be constrained. This is an administrator permission.||Edge|