Using the CreateTalent API

Additional Supporting Documentation

• CreateTalent API
  
• New Talent Requirements API
• Talent Requirements

Duplicate Check

Scenario #1: Full SSN

• • Regardless of other talent fields, if SSN is passed in the API request, then the duplicate check will only look at the full SSN.

Scenario #2: No SSN

• • If there is no SSN in the API request, the API will attempt to identify a duplicate talent by comparing:
    • • First Name
    • AND
      • Last Name
    • AND
      • (Email OR Mobile Phone)

Examples:

• New talent records are NOT created:
  • If First Name, Last Name, & Mobile Phone match for an existing talent record
  • If First Name, Last Name, & Email match for an existing talent record
  • If provided SSN is already associated to an existing talent

• New talent records can be created:
  • If provided different (first or last name) AND matching mobile phone
  • If provided different (first and last name) AND matching mobile phone
  • If provided first name and last name match an existing record and SSN, email, and mobile phone are not provided
  • If provided First Name & last name are the same with a different SSN 
  • If provided First Name & last name are the same with a different email

• Other:
  
  • If provided mobile phone has characters in it, the characters will be stripped out and the duplicate check will only compare against the numeric value

Creating Talent

1. Generate a Bearer Token
   1. Click here for information on creating a Bearer Token.
2. Enter the Request Body JSON
   • Important Note:
     • The API consumer must always pass the same Origin value for every API call.
     • Limit the number of characters to 20. 
       • Example: Sense, Able, ...
     • "API" will be appended to the end of the Origin Field value that was passed.
       • Example: SenseAPI, AbleAPI
3. Call the API with the Bearer Token
4. The 'Duplicate check' process will run
   1. Duplicate Check section
5. The required field validation will run and provide a Successful or Error message
   • It's recommended to use the GetNewTalentRequirement API to retrieve the list of required fields needed to be populated in the request in order to create a talent record.  Not all required fields set for creating new Talent are available when using this API.
   • Talent Requirement fields
6. If the duplicate check runs and doesn't find a duplicate record, and all the new talent requirements are fulfilled, a talent record will be created.
   1. Error Check section

Sample Request Body

{
  "id": 0,
  "firstName": "john",
  "middleName": "allan",
  "lastName": "locke",
  "homePhone": "demo",
  "workPhone": "demo",
  "mobilePhone": "asas",
  "emailAddress": "[e-mail]",
  "taxIdNumber": "456783510",
  "birthday": "Dec 4 2020",
  "gender": "male",
  "residentAddress": {
  "street1": "string",
  "street2": "string",
  "city": "string",
  "state_Province": "string",
  "postalCode": "string",
  "country": "canada",
  "county": "test",
  "geoCode": "test",
  "schoolDistrictCode": "string"
  },
  "payrollAddress": {
  "street1": "string",
  "street2": "string",
  "city": "string",
  "state_Province": "string",
  "postalCode": "string",
  "country": "string",
  "county": "string",
  "geoCode": "string",
  "schoolDistrictCode": "string"
  },
  "frontOfficeId": 0,
  "w2Consent": true,
  "availabilityDate": "",
  "statusId": 1,
  "createdDate": "1/1/2021 12:00:00",
  "lastUpdatedDate": "1/1/2021 12:00:00",
  "race": "string",
  "disability": "string",
  "veteranStatus": "string",
  "flag": "string",
  "officeName": "string",
  "officeDivision": "string",
  "origin": "test",
  "status": "test"
}

Sample Response Body

 { 
   "id": 2864972,
    "firstName": "john",
    "middleName": "allan",
    "lastName": "locke",
    "homePhone": "demo",
    "workPhone": "demo",
    "mobilePhone": "asas",
    "pageNumber": null,
    "emailAddress": "[e-mail]",
    "taxIdNumber": "456783510",
    "birthday": "2020-12-04T00:00:00",
    "gender": "M",
    "hireDate": null,
    "residentAddress": {
    "street1": "string",
    "street2": "string",
    "city": "string",
    "state_Province": "string",
    "postalCode": "string",
    "country": "CA",
    "county": null,
    "geoCode": "test",
    "schoolDistrictCode": "string"
  },
    "mailingAddress": {
    "street1": "string",
    "street2": "string",
    "city": "string",
    "state_Province": "string",
    "postalCode": "string",
    "country": "CA",
    "county": null,
    "geoCode": "test",
    "schoolDistrictCode": "string"
  },
    "payrollAddress": {
    "street1": "string",
    "street2": "string",
    "city": "string",
    "state_Province": "string",
    "postalCode": "string",
    "country": "US",
    "county": null,
    "geoCode": "string",
    "schoolDistrictCode": "string"
  },
    "addresses": [
        {
     "street1": "string",
     "street2": "string",
     "city": "string",
     "state_Province": "string",
     "postalCode": "string",
     "country": "CA",
     "county": null,
     "geoCode": "test",
     "schoolDistrictCode": "string"
    }
  ],
    "status": null,
    "filingStatus": "None",
    "federalAllowances": 0,
    "stateAllowances": 0,
    "additionalFederalWithholding": 0.0,
    "i9ValidatedDate": null,
    "frontOfficeId": 0,
    "latestActivityDate": null,
    "latestActivityName": null,
    "link": null,
    "race": "string",
    "disability": "string",
    "veteranStatus": "string",
    "emailOptOut": false,
    "isArchived": false,
    "placementStatus": null,
    "representativeUser": 0,
    "w2Consent": true,
    "referredBy": null,
    "availabilityDate": null,
    "statusId": 1,
    "officeName": null,
    "officeDivision": null,
    "enteredByUserId": 7,
    "enteredByUser": null,
    "representativeUserEmail": null,
    "createdDate": "2021-01-01T12:00:00",
    "lastUpdatedDate": "2021-01-01T12:00:00",
    "latestWork": null,
    "lastContacted": null,
    "flag": "string"
}

Errors

Talent Requirement fields

Field	Error Type	Example	Error Message (Response)
SSN	Duplicate SSN	SSN already in the system.	{  "error": " Multiple Duplicates found: 2863838" }
	Must be 9 digits	If the SSN provided isn't 9 digits	{ "error": " Error: SsnValue \"45678351\" must be nine digit. Unable to perform duplicate check." }
	NULL SSN	NULL is listed for the SSN	{ "error": " Error: SsnValue \"NULL\" must be nine digits. Unable to perform duplicate check." }
Required Fields	New Talent Requirements missing	The email is required by not provided	{" error": " Email is required. Please provide required fields and try again." }