Retrieve an existing Employer

Request

Returns an existing Employer with the input candidate_id or employer_id.

Security

basic_auth

Path

employer_idstringrequired

The Employer's ID.

candidate_idstringrequired

The Candidate's ID.

curl -i -X GET \
  -u '<username>:<password>' \
  'https://docs.checkr.com/_mock/apis/openapi/candidates/{candidate_id}/employers/{employer_id}'

Responses

Employer details

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"

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

ID of the Candidate being screened.

Example:"xxx"

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

Candidate’s employer’s name.

Example:"Checkr"

positionstring

Candidate’s position or title.

Example:"Software Engineer"

salaryinteger

Candidate’s gross salary in dollars annually.

Example:10000

contract_typestring

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)

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)

managerobject

Response

{
  "id": "e44aa283528e6fde7d542194",
  "object": "employer",
  "uri": "/v1/candidates/e44aa283528e6fde7d542194/employers/ca27df84be5b50dfa7ee1cda",
  "candidate_id": "xxx",
  "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"
  }
}