Sign in

v1

latestOpenAPI 3.0.32026-07-14265579.8 KB
Candidate

Retrieve Candidate resources

Retrieve candidate resource is used to retrieve all company candidates. Candidates with a specific name can be returned by passing the firstName and lastName parameters.

get/candidate

Query parameters

ssnstring

Social Security number or other national id

middleNamestring

Middle Name

firstNamestring

First Name

lastNamestring

Last Name

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"
    }
  }
]