Shortlisting

Access MeVitae’s API to integrate shortlisting into your hiring process

  • Access token

    To generate the access token, please follow these steps

    As soon as you login to the system, you will be welcomed with this message in the centre of the screen. Please click Generate

    You will now have a new access code generated

    Please note: The generated token gives access to all the following features and data mentioned below

  • Request Limits

    Based on the type of account held by the user the requests are limited to the following for every 10 seconds

    Users exceeding the limits will receive the following message in their HTTP headers for efficient throttling

    Json result
     {
    "error":  "limit reached, please try back in 4 seconds"
     }

    If you are exceeding the rate limit with these features, please contact us

  • POST

    /upload/jobspec

    For MeVitae to perform candidate shortlisting the user is expected to first upload the job description for us to perform preliminary analysis. We will then generate an output andUnique Id for the uploaded job.


    Path Parameters

    user_id:
    required
    string
    The account member uploading the job specification

    Query Parameters

    Key Type Description
    job_name string The job description's name
    job_data string The job description encoded in base64

    Json return

    Uploading the the job description to the /upload/jobspec api returns with the following keys
  • POST

    /upload/cvs

    Following the job description being uploaded, the user will require the generated job_id to batch upload the cvs for scoring and tagging. We will then return with an estimated wait time to complete the analysis.


    Path Parameters

    job_id:
    required
    string
    The unique id of the uploaded job

    Query Parameters

    Key Type Description
    scoring string Following are the different types of scoring MeVitae provides.
    • none - no scoring will be performed when this option is selected
    • blind - CVs will be reordered in descending order based on relevance to the job description
    • relevance - blind scoring will be performed in addition to each CV having a score
    • detailed - CVs will undergo relevance scoring and other AI components will kick in to make a smart score
    tagging string Following are the different types of tagging MeVitae provides.
    • none - no tagging will be performed when this option is selected
    • simple - All the relevant tags will get highlighted on the CV
    • detailed - Simple tagging will be performed in addition to clearly explaining all the highlights
    bias_correction string Following are the different types of bias correction MeVitae provides.
    • none - no tagging will be performed when this option is selected
    • redact - All the bias inducing factors will get redacted from the CV
    • replace - All the bias inducing factors get replaced with machine learnt neutral words in the CV (experimental)
    cvs arrays Collection of CVs in the following model

    Json return

    Uploading the cvs to the /upload/cvs api returns with the following keys
  • GET

    /shortlists

    The user can retrieve all the shortlists after the wait_time for analysis completes.

    Path Parameters

    job_id:
    required
    string
    The unique id of the uploaded job

    Json return

    Retrieve the collection of all the uploaded CVs scored and tagged based on options set during upload. Each CV will have the following keys.

Support

Please contact [email protected] with any questions.