/candidates

post https://api-int.kennect.com/v2/candidates

Create a candidate. The minimum requirements are labeled below. Additional fields (e.g., address, driversLicense, etc.) may be required depending on screening.

Request to create a new candidate

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, such as "Tim" in "Tim Duncan".

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, such as "Rowling" in "Joanne K Rowling".

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.

Responses

Language

Credentials

OAuth2

Request


xxxxxxxxxx
127
          "supervisorMiddleName" : "supervisorMiddleName",
1
curl -X POST \
2
  https://api-int.kennect.com/v2/candidates \
3
  -d '{
4
    "clientReferenceId": "99912441",
5
    "givenName": "John",
6
    "confirmedNoMiddleName": true,
7
    "familyName": "Doe",
8
    "dob": "1990-01-20",
9
    "email": "john.doe@example.com",
10
    "phone": "+14041231234",
11
    "ssn": "123456789",
12
    "address": {
13
      "addressLine": "123 Main Street",
14
      "municipality": "Orlando",
15
      "regionCode": "US-FL",
16
      "postalCode": "12345",
17
      "countryCode": "US"
18
    },
19
    "driversLicense": {
20
      "type": "personal",
21
      "licenseNumber": "S1234567",
22
      "issuingAgency": "CA"
23
    },
24
    "aliases": [
25
      {
26
        "givenName": "Robert",
27
        "familyName": "Saur",
28
        "middleName": "William",
29
        "confirmedNoMiddleName": false

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201201

400400

409409