Create a new Postal Address

Request

Creates a new Postal Address for a given candidate.

Security

basic_auth

Path

candidate_idstringrequired

The candidate's ID.

Bodyapplication/json

namestringrequired

Name of the Candidate.

Example:"John Smith"

streetstringrequired

Street address of the Candidate.

Example:"123 Main St"

street2string or null

Additional street address of the Candidate.

Example:"Apt A"

citystringrequired

City of the Candidate.

Example:"Santa Monica"

statestringrequired

State of the Candidate.

Example:"CA"

zipcodestringrequired

5-digit zip code of the Candidate.

Example:"90401"

curl -i -X POST \
  -u '<username>:<password>' \
  'https://docs.checkr.com/_mock/apis/openapi/candidates/{candidate_id}/postal_address' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "John Smith",
    "street": "123 Main St",
    "street2": "Apt A",
    "city": "Santa Monica",
    "state": "CA",
    "zipcode": "90401"
  }'

Responses

Candidate Postal Address was successfully created

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