Apply API

Overview

This is the official documentation for the JazzHR Apply API.

The Apply API allows partners to send applications to JazzHR through a RESTful interface.

Authenticating Requests

Authorization: Bearer <token>

The bearer token associated with the verified JazzHR user will be included in the Authorization header of all requests, except for the initial request to /authenticate which will return that token.

This bearer token should uniquely identify the user within the Apply API.

POST authentication

Endpoint

POST https://applyapi.jazz.co/v2/authentication

Request Headers

Accept: application/json
Authorization: Token <token>
Content-Type: application/json

Request Body

{
    "userName": "[email protected]",
    "password": "<password>"
}

Response Headers

Content-Type: application/json

Response Body

{
    "token": "<token>"
}

Generates an authentication token for the specified username and password.

The token included in the response should be included in the header of subsequent requests

The lifetime for this generated token is 48 hours. Ideally, it should be cached and regenerated when it expires (subsequent requests respond with a 401 HTTP status code).

GET questions

Endpoint

GET https://applyapi.jazz.co/v2/job/<jobBoardCode>/question

Request Headers

Accept: application/json
Authorization: Token <token>
Content-Type: application/json

200 Response Headers

Content-Type: application/json

200 Response Body Example

[
    {
        "id": "firstName",
        "format": "Text",
        "isRequired": true,
        "label": "First Name",
        "options": null,
        "maxLength": 50,
        "group": null
    },
    {
        "id": "1",
        "format": "Select",
        "isRequired": false,
        "label": "What is your favorite fruit?",
        "options": [
            "Apple",
            "Orange",
            "Banana"
        ],
        "maxLength": null,
        "group": null
    },
    {
        "id": "eeocDisability",
        "format": "Select",
        "isRequired": true,
        "label": "Disability",
        "options": [
            "Yes, I have a disability, or have had one in the past",
            "No, I do not have a disability and have not had one in the past",
            "I do not want to answer"
        ],
        "maxLength": null,
        "group": "complianceOfccp"
    },
    {
        "id": "eeocDisabilitySignature",
        "format": "Text",
        "isRequired": true,
        "label": "Name",
        "options": null,
        "maxLength": 255,
        "group": "complianceOfccp"
    },
    {
        "id": "eeocDisabilitySignatureDate",
        "format": "Date",
        "isRequired": false,
        "label": "Date",
        "options": null,
        "maxLength": null,
        "group": "complianceOfccp"
    }
]

400 Response Headers

Content-Type: application/json

400 Response Body Example

{
    "code": 400,
    "message": "<message>"
}

Returns the questions for the specified job ID.

A question will have one of the following formats:

Checkbox
Date
Email
File
Number
Phone
Select
Text
Textarea

Questions of format Checkbox and Select will include an array of string options.

Some questions include a maxLength property that should ideally be enforced on the rendered HTML input element.

Parameters

jobBoardCode (required, string)

JSON Feed

JazzHR has a global JSON based feed containing a list of jobs and job details that all JazzHR customers have chosen to syndicate. jobBoardCode can be found at node positionProfiles.positionId.value.

You can find example JSON here.

Compliance Groups

Some jobs will include required compliance-related questions with a defined group property that corresponds to one of the groups noted below. Each compliance group contains one or more questions that should be rendered together and prefixed with their respective legal text.

`complianceEeo`

Two EEO-1 question for gender and race should be prefixed with the following text:

`complianceOfccp`

Three OFCCP Form CC-305 questions request voluntary self-identification of disability and should be prefixed with the following text:

Voluntary Self-Identification of Disability

Voluntary Self-Identification of Disability Form CC-305
OMB Control Number 1250-0005
Expires 04/30/2026

Why are you being asked to complete this form?

We are a federal contractor or subcontractor. The law requires us to provide equal employment opportunity to qualified people with disabilities. We have a goal of having at least 7% of our workers as people with disabilities. The law says we must measure our progress towards this goal. To do this, we must ask applicants and employees if they have a disability or have ever had one. People can become disabled, so we need to ask this question at least every five years.

Completing this form is voluntary, and we hope that you will choose to do so. Your answer is confidential. No one who makes hiring decisions will see it. Your decision to complete the form and your answer will not harm you in any way. If you want to learn more about the law or this form, visit the U.S. Department of Labor’s Office of Federal Contract Compliance Programs (OFCCP) website at www.dol.gov/ofccp.

How do you know if you have a disability?

A disability is a condition that substantially limits one or more of your “major life activities.” If you have or have ever had such a condition, you are a person with a disability. Disabilities include, but are not limited to:

Alcohol or other substance use disorder (not currently using drugs illegally)
Autoimmune disorder, for example, lupus, fibromyalgia, rheumatoid arthritis, HIV/AIDS
Blind or low vision
Cancer (past or present)
Cardiovascular or heart disease
Celiac disease
Cerebral palsy
Deaf or serious difficulty hearing
Diabetes
Disfigurement, for example, disfigurement caused by burns, wounds, accidents, or congenital disorders
Epilepsy or other seizure disorder
Gastrointestinal disorders, for example, Crohn's Disease, irritable bowel syndrome
Intellectual or developmental disability
Mental health conditions, for example, depression, bipolar disorder, anxiety disorder, schizophrenia, PTSD
Missing limbs or partially missing limbs
Mobility impairment, benefiting from the use of a wheelchair, scooter, walker, leg brace(s) and/or other supports
Nervous system condition, for example, migraine headaches, Parkinson’s disease, multiple sclerosis (MS)
Neurodivergence, for example, attention-deficit/hyperactivity disorder (ADHD), autism spectrum disorder, dyslexia, dyspraxia, other learning disabilities
Partial or complete paralysis (any cause)
Pulmonary or respiratory conditions, for example, tuberculosis, asthma, emphysema
Short stature (dwarfism)
Traumatic brain injury

PUBLIC BURDEN STATEMENT: According to the Paperwork Reduction Act of 1995 no persons are required to respond to a collection of information unless such collection displays a valid OMB control number. This survey should take about 5 minutes to complete.

`complianceVevraa`

The voluntary self-identification of protected veteran status question should be prefixed with the following text:

Invitation for Job Applicants to Self-Identify as a U.S. Veteran

A “disabled veteran” is one of the following:
- a veteran of the U.S. military, ground, naval or air service who is entitled to compensation (or who but for the receipt of military retired pay would be entitled to compensation) under laws administered by the Secretary of Veterans Affairs; or
- a person who was discharged or released from active duty because of a service-connected disability.
A “recently separated veteran” means any veteran during the three-year period beginning on the date of such veteran's discharge or release from active duty in the U.S. military, ground, naval, or air service.
An “active duty wartime or campaign badge veteran” means a veteran who served on active duty in the U.S. military, ground, naval or air service during a war, or in a campaign or expedition for which a campaign badge has been authorized under the laws administered by the Department of Defense.
An “Armed forces service medal veteran” means a veteran who, while serving on active duty in the U.S. military, ground, naval or air service, participated in a United States military operation for which an Armed Forces service medal was awarded pursuant to Executive Order 12985.

POST application

Endpoint

POST https://applyapi.jazz.co/v2/application

Request Headers

Accept: application/json
Authorization: Token <token>
Content-Type: application/json

Request Body Example

{
    "jobBoardCode": "BvGJvE",
    "source": "Example Source",
    "answers": [
        {
            "questionId": "firstName",
            "value": "John"
        },
        {
            "questionId": "lastName",
            "value": "Smith"
        },
        {
            "questionId": "startDate",
            "value": "2016-12-01"
        },
        {
            "questionId": "email",
            "value": "[email protected]"
        },
        {
            "questionId": "file",
            "value": "Sm9obiBTbWl0aApTb2Z0d2FyZSBFbmdpbmVlcgpKYXp6SFI="
        },
        {
            "questionId": "1",
            "value": "100"
        },
        {
            "questionId": "phone",
            "value": "(888) 885-5299"
        },
        {
            "questionId": "citizenWorkStatus",
            "value": "U.S. Citizen/Permanent Resident"
        }
    ]
}

204 Response Headers

Content-Type: application/json

400 Response Headers

Content-Type: application/json

400 Response Body Example

{
    "code": 400,
    "message": "<message>",
    "errors": null
}

400 Response Body Example

When there are failed validation constraints for specific answer values, an "errors" property will be included.

[
    {
        "questionId": "11",
        "messages": [
            "This answer is required"
        ]
    },
    {
        "questionId": "email",
        "messages": [
            "This value is not a valid email address."
        ]
    }
]

Creates an application.

All answer values are of type string with specific validation constraints enforced for each format.

Checkbox

Value is one or more of the related question options, delimited by a pipe character (|). Options that contain a pipe should be escaped by a backslash character ().

Date

Value is of the format "YYYY-MM-DD".

Email

Value is a valid email address.

File

Value is the base64-encoded file contents for a file under 10MB with one of the following accepted MIME types:

Valid Values:

application/pdf
application/msword
application/vnd.openxmlformats-officedocument.wordprocessingml.document
application/postscript
image/png
image/gif
image/jpeg
application/rtf
text/plain
audio/mpeg3
audio/x-mpeg-3
audio/mpeg
audio/mp3
video/mpeg
audio/mp4
video/mp4
application/mp4
application/vnd.ms-powerpoint
application/vnd.openxmlformats-officedocument.presentationml.presentation
image/vnd.adobe.photoshop
image/tiff
text/x-vcard
audio/x-wav
video/x-ms-wmv
video/x-ms-asf
application/vnd.ms-excel
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
application/zip
application/x-gtar
application/x-tar
application/tar
application/gzip
text/richtext
text/rtf
application/x-rtf
application/vnd.oasis.opendocument.text

Resume

The question with an ID "resume" (and format "File") must be under 2MB with one of the following accepted MIME types:

Valid Values:

application/pdf
application/msword
application/vnd.openxmlformats-officedocument.wordprocessingml.document
application/vnd.oasis.opendocument.text
application/rtf
application/x-rtf
text/rtf
text/richtext
application/postscript
text/plain

Number

Value is a numeric string.

Phone

Value contains at least seven numeric characters.

Select

Value is one of the related question options.

Text & Textarea

Value length is less than or equal to the question's "maxLength" property, if defined.

Changelog

v2 (August 2020)

Improves behavior of compliance-related questions:

Adds optional group property to question objects
Requires compliance-related questions when exposed, and adds "decline to answer" options
Adds Compliance Groups documentation