Create a new School

Request

Creates a new School resource.

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.

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

year_awarded
phone
minor
start_date
end_date
current
address
- street
- city
- zipcode
- state
- country

Security

basic_auth

Path

candidate_idstringrequired

Creates a School for the input candidate_id.

Bodyapplication/jsonrequired

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

Candidate linked to this School resource.

Example:"83ebeagdec0948690863766f792ead24d61fe3f9"

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

Name of the School.

Example:"College University"

degreestringrequired

Degree awarded to the Candidate.

Example:"BA"

year_awardedinteger, non-empty

Year in which the degree was awarded.

Example:2017

majorstring[a-zA-Z0-9 -'.,]*required

Candidate’s major.

Example:"Russian Literature"

phonestring or null

School's phone number.

Example:"415-111-1111"

minorstring

Candidate’s minor.

Example:"Background Checks"

start_datestring, (date)

Candidate’s start date with the School.

Example:"2012-09-22"

end_datestring, (date)

Candidate’s end date with the School.

Example:"2017-05-10"

currentboolean

Defines whether the Candidate is currently enrolled.

Default:false

school_urlstring

School’s website.

Example:"www.collegeuniversity.com"

addressobject(Address)required

curl -i -X POST \
  -u '<username>:<password>' \
  'https://docs.checkr.com/_mock/apis/openapi/candidates/{candidate_id}/schools' \
  -H 'Content-Type: application/json' \
  -d '{
    "candidate_id": "83ebeagdec0948690863766f792ead24d61fe3f9",
    "name": "College University",
    "degree": "BA",
    "year_awarded": 2017,
    "major": "Russian Literature",
    "phone": "415-111-1111",
    "minor": "Background Checks",
    "start_date": "2012-09-22",
    "end_date": "2017-05-10",
    "current": false,
    "school_url": "www.collegeuniversity.com",
    "address": {
      "street": "123 Main St.",
      "unit": 2000,
      "city": "San Francisco",
      "state": "CA",
      "zipcode": "90401",
      "country": "US"
    }
  }'

Responses

School was successfully created

Bodyapplication/json

idstring(ResourceId)read-only

ID of the resource.

Example:"e44aa283528e6fde7d542194"

objectstringread-only

Value:"school"

uristring(ResourceURI)read-only

URI of the resource.

Example:"/v1/schools/e44aa283528e6fde7d542194"