Add a Prospective Employee

Add a prospective employee in draft status for onboarding in the system. This API can be used to send candidate information from ATS platforms or other systems. As soon as the candidate's information is synced in our system, you can either send an offer letter, set up self-onboarding to get documents signed and details filled in by the candidate, or do the onboarding yourself.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

EmployeeDetails

personal
object
job
object
contact
object
addtionalDetails
object

addtionalDetails

Headers
string
required

The company unique identifier

Responses

400

In case the request has some invalid parameter.

401

In case Security key is not provided or invalid.

500

In case system is unable to fulfil the request due to some internal error.

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*