/candidates/{id}

Time	Status	User Agent
Retrieving recent requests…

Time

Status

User Agent

Retrieving recent requests…

Path Params

string

required

The unique identifier for the candidate resource, assigned by the Sterling On Demand API

Body Params

clientReferenceId

string

required

An identifier, such as a user id, to facilitate linking candidates back to entities in your own system. Must be unique.

givenName

string

required

The candidate's given or "first" name

middleName

string

The candidate's middle name, useful for differentiating between individuals with similar names in public record searches.

confirmedNoMiddleName

boolean

true if the the candidate has no legal name. false if the candidate may have a legal middle name.

familyName

string

required

The candidate's family name

string

required

The email provided by the candidate. Must be a unique, valid email.

dob

string

Date of birth, formatted as an ISO-8601 date (without the time component). For example, July 4, 1979 would be represented as "1979-07-04".

phone

string

A phone number associated with the candidate, formatted as an E.164 string, such as +15555551234

ssn

string

The social security number for the candidate, formatted as a series of numbers with no dashes 123551234

address

object

Address of candidate. Please refer to Address

driversLicense

object

Driver's license information of candidate. Please refer to DriversLicense

aliases

object

List of Candidate Aliases : Alternate information the candidate may also be known by. Please refer to CandiateAlias

201201