/candidates/{id}

put https://api-int.kennect.com/v2/candidates/{id}

Update an existing candidate's information.

Path Params

string

required

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

Body Params

clientReferenceId

string

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.

Response

Language

Credentials

OAuth2

Request


xxxxxxxxxx
126
1
curl -X PUT \
2
  https://api-int.kennect.com/v2/candidates/733d9194-f36b-4468-9219-af45e27257b5 \
3
  -d '{
4
  "clientReferenceId": "e4e1ffda-caa3-ea6d-c095-be8429b31154",
5
  "email": "john.doe@example.com",
6
  "givenName": "John",
7
  "familyName": "Doe",
8
  "confirmedNoMiddleName": true,
9
  "dob": "1998-07-18",
10
  "ssn": "123456789",
11
  "phone": "+14041231234",
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": "Chris",
27
      "familyName": "Jenkins",
28
      "confirmedNoMiddleName": true
29
    },

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

application/json

200200