ACaccuratebackground
Candidate

Create candidate resource

Creates a candidate that can then be submitted within the Order Creation payload by id.

Note: Alternatively, candidates can be created on-the-fly during order creation by including the candidate details directly within the Order Creation payload.

post/candidate

Request

  • Base URL
    https://api.accuratebackground.com/v3
  • URL
    https://api.accuratebackground.com/v3/candidate
  • Auth
    HTTP basic

Request body

firstNamestring required

First name of candidate.

lastNamestring required
middleNamestring

Last name of candidate.

suffixstring
dateOfBirthstring date

Required only for Express workflow.

ssnstring

Social Security Number.

Required only for Express workflow.

emailstring email required

Some workflows require contacting the candidate via email.

phonestring

Required only for Express workflow.

addressstring

Candidate’s street address.

citystring

City candidate resides in.

regionstring

State candidate resides in.

countrystring

Country code of candidate. Accurate Background uses ISO 3166 Country Codes.

postalCodestring

Candidate’s postal code.

prevEmployedboolean

Required for EMP product only in Express workflow, Indicates if candidate has previous employment history. prevEmployed will default as “false” when no value is provided. Only required if employment information is entered.

convictedboolean

Example request

{
  "firstName": "Elmer",
  "lastName": "Fudd",
  "middleName": "Fiddlesticks",
  "suffix": "Jr",
  "dateOfBirth": "1945-01-01T00:00:00.000Z",
  "email": "Elmer@wb.com",
  "address": "123 Silly Street",
  "city": "Lousville",
  "region": "KY",
  "country": "US",
  "governmentId": {
    "country": "US",
    "type": "SpyCard",
    "number": "ABC12345"
  }
}

Response

Success Response

resourcestring
idstring
createdstring date-time
updatedstring date-time
revisionstring
maskedboolean
firstNamestring
lastNamestring
middleNamestring
suffixstring
dateOfBirthstring date
ssnstring
emailstring email
phonestring
addressstring
citystring
regionstring
countrystring
postalCodestring
prevEmployedboolean
convictedboolean

Must be configured by reaching out to apisupport@accuratebackground.com; Has candidate been convicted?

Example response

{
  "firstName": "Elmer",
  "lastName": "Fudd",
  "middleName": "Fiddlesticks",
  "suffix": "Jr",
  "dateOfBirth": "1945-01-01T00:00:00.000Z",
  "email": "Elmer@wb.com",
  "address": "123 Silly Street",
  "city": "Lousville",
  "region": "KY",
  "country": "US",
  "governmentId": {
    "country": "US",
    "type": "SpyCard",
    "number": "ABC12345"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.