Employers

The Employers resource includes all relevant employer information for the specified Candidate. Employer resources are tied to the specified candidate, and do not transfer to other employees within the system. Once attached to a candidate, all employers are retained when running subsequent employment verifications. For example, if multiple employment verifications are run for an existing candidate, each report will use all employers attached to that candidate for the verification.

Operations

Create a new Employer

Request

Creates a new Employer resource.

If the country is not US, the following parameters will be required in addition to those marked as required in the table below:

salary
address:
- street
- country
- zipcode
manager:
- name
- title

Validation for start_date and end_date is performed to ensure logical dates are provided. end_date must be after start_date, and both dates must be after 1900-01-01.

Security

basic_auth

Path

candidate_idstringrequired

Create an employer for the input candidate_id.

Bodyapplication/jsonrequired

candidate_idstring, non-empty[a-zA-Z0-9 -'.,]*

ID of the Candidate being screened.

Example:"xxx"

typestring

Type of employment history to be created.

If type is set to gap only start_date is required, and only start_date, end_date, and note will be recorded.

Default:"employer"

Enum:"employer""gap"

namestring, non-empty[a-zA-Z0-9 -'.,]*required

Candidate’s employer’s name.

Example:"Checkr"

positionstringrequired

Candidate’s position or title.

Example:"Software Engineer"

salaryinteger

Candidate’s gross salary in dollars annually.

Example:10000

contract_typestringrequired

Candidate’s contract type.

Enum:"full_time""part_time""contract""internship"

Example:"full_time"

do_not_contactboolean

If true, the employer will not be contacted about the Candidate.

Default:false

Example:false

start_datestring, (date)required

Candidate’s start date with the employer.

Example:"2016-06-01"

end_datestring, (date)

Candidate’s end date with the employer.

Example:"2017-05-01"

employer_urlstring

Employer’s website.

Example:"www.employer.com"

addressobject(Address)required

managerobject

notestring, <= 65535 characters

A text note used to add context for an employment gap.

Example:"Took time off to travel abroad."

curl -i -X POST \
  -u '<username>:<password>' \
  'https://docs.checkr.com/_mock/apis/openapi/candidates/{candidate_id}/employers' \
  -H 'Content-Type: application/json' \
  -d '{
    "candidate_id": "xxx",
    "type": "employer",
    "name": "Checkr",
    "position": "Software Engineer",
    "salary": 10000,
    "contract_type": "full_time",
    "do_not_contact": false,
    "start_date": "2016-06-01",
    "end_date": "2017-05-01",
    "employer_url": "www.employer.com",
    "address": {
      "street": "123 Main St.",
      "unit": 2000,
      "city": "San Francisco",
      "state": "CA",
      "zipcode": "90401",
      "country": "US"
    },
    "manager": {
      "name": "Joe Smith",
      "title": "Engineering Manager",
      "email": "joesmith@checkr.co",
      "phone": "212-555-1234"
    },
    "note": "Took time off to travel abroad."
  }'

Responses

Employer was successfully created

Bodyapplication/json

idstring(ResourceId)read-only

ID of the resource.

Example:"e44aa283528e6fde7d542194"

objectstringread-only

Value:"employer"

uristring(ResourceURI)read-only

URI of the resource.

Example:"/v1/candidates/e44aa283528e6fde7d542194/employers/ca27df84be5b50dfa7ee1cda"