Get the Candidate's Postal Addresses

Request

Returns the Postal Address of a given candidate.

Security

basic_auth

Path

candidate_idstringrequired

The candidate's ID.

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

Responses

Candidate postal address

Bodyapplication/json

idstring(ResourceId)read-only

ID of the resource.

Example:"e44aa283528e6fde7d542194"

objectstringread-only

Value:"candidate_postal_address"

candidate_idstring(ResourceId)read-only

ID of the resource.

Example:"e44aa283528e6fde7d542194"

uristring(ResourceURI)read-only

URI of the resource.

Example:"/v1/candidate/e44aa283528e6fde7d542194/postal_address"

namestring

Name of the Candidate.

Example:"John Alfred Smith"

streetstring

Street address of the Candidate.

Example:"123 Main St"

street2string or null

Additional street address of the Candidate.

Example:"Apt A"

citystring

City of the Candidate.

Example:"Santa Monica"

statestring

State of the Candidate.

Example:"CA"

zipcodestring

5-digit zip code of the Candidate.

Example:"90401"

Response

{
  "id": "e44aa283528e6fde7d542194",
  "object": "candidate_postal_address",
  "candidate_id": "e44aa283528e6fde7d542194",
  "uri": "/v1/candidate/e44aa283528e6fde7d542194/postal_address",
  "name": "John Alfred Smith",
  "street": "123 Main St",
  "street2": "Apt A",
  "city": "Santa Monica",
  "state": "CA",
  "zipcode": "90401"
}