Retrieve candidate resource by id

200

Success Response

Response body

object

resource

string

created

date-time

updated

date-time

revision

string

masked

boolean

firstName

string

lastName

string

middleName

string

suffix

string

dateOfBirth

date

ssn

string

phone

string

address

string

city

string

region

string

country

string

postalCode

string

governmentId

object

country

string

Country code where the government identification was issued.

type

string

Type of government Id (national identity card, etc.)

number

string

Government Id number

aliases

array of objects

aliases

object

firstName

string

lastName

string

middleName

string

educations

array of objects

educations

object

school

string

Required for EDU product only in Express workflow; School candidate attended. Only required if education information is entered.

country

string

Required for EDU product only in Express workflow; Country code of school. Only required if education information is entered. Accurate Background uses ISO 3166 Country Codes.

region

string

Required for EDU product only in Express workflow; State of school. Only required if education information is entered.

city

string

Required for EDU product only in Express workflow; City of school. Only required if education information is entered.

degree

string

Required for EDU product only in Express workflow; Candidate’s degree at school

major

string

Required for EDU product only in Express workflow; Candidate’s major at school

startDate

string

Required for EDU product only in Express workflow; In the format: yyyy-mm, start date candidate attended school. Only required if education information is entered.

endDate

string

Required for EDU product only in Express workflow; In the format: yyyy-mm, end date candidate finished school. Only required if education information is entered.

graduated

string

Required for EDU product only in Express workflow; Has the candidate graduated?

graduationDate

string

Required for EDU product only in Express workflow; In the format: yyyy-mm, graduation date

presentlyEnrolled

string

Required for EDU product only in Express workflow; Is the candidate currently in school? PresentlyEnrolled will default as "false" when no value is provided

prevEmployed

boolean

employments

array of objects

employments

object

employer

string

Required for EMP product only in Express workflow, Name of company candidate was previously employed. Only required if PrevEmployed is “true”.

country

string

Required for EMP product only in Express workflow, Country code of company. Only required if employment information is entered. Accurate Background uses ISO 3166 Country Codes.

region

string

state of company. Only required if employment information is entered.

city

string

Required for EMP product only in Express workflow; State of company. Only required if employment information is entered.

startDate

string

Required for EMP product only in Express workflow; In the format: yyyy-mm, start date at company. Only required if employment information is entered.

endDate

string

Required for EMP product only in Express workflow; In the format: yyyy-mm, end date at company. Only required if employment information is entered.

presentlyEmployed

string

Required for EMP product only in Express workflow; Is this the candidate’s current employer? presentlyEmployed will default as “false” when no value is provided

position

string

Required for EMP product only in Express workflow; Position at company

supervisor

string

Required for EMP product only in Express workflow; Supervisor at company

reasonForLeaving

string

Required for EMP product only in Express workflow; Reason for leaving company

okToCall

string

Required for EMP product only in Express workflow; Is it ok to contact the employer? okToCall will default as “true” when no value is provided

phone

string

Required for EMP product only in Express workflow; Employer’s phone number

salary

string

Required for EMP product only in Express workflow; Salary at company

contactEmail

string

Email of contact for employment verification. Required for Email Verification product.

contactTitle

string

Title of contact for employment verification. Required for Email Verification product.

contactPerson

string

Name of contact for employment verification. Required for Email Verification product.

licenses

array of objects

licenses

object

200Success Response

401Unauthorized Response

500Internal Server error