FAQs

Integration Errrors

"Message":"Authorization has been denied for this request."

 Have the client verify that the user the API Key was generated under has org admin permissions (with cog access enabled) and that the user is active in the PI Software. If the user has been disabled, a new API Key will need to be generated under a different user

Why are my candidates not receiving an assessment sent via the API?

Possible reasons for a candidate not receiving an assessment include:

• Verify that the notifyAssessmentTakerUsingEmail property is set to true.

• Verify that the candidate does not already exist with a completed assessment. See the section below this on scenarios where an assessment will not be sent for existing candidates.

When sending assessments, when will a new candidate be created or an existing candidate be used and how will I know?

The candidates-v1 POST endpoint returns a property of isExistingCandidate that will indicate whether or not a new candidate record was created as part of the assessment sending operation.

The creation or reuse of a candidate will behave as follows in these common scenarios:

• If there is no candidate found:

  • IsExistingCandidate = false,

  • New Behavioral Assessment sent (if requested),

  • New Cognitive Assessment sent (if requested)

• If there is a candidate found with completed Behavioral Assessment + Cognitive Assessment :

  • IsExistingCandidate = true

  • No assessments sent

  • Behavioral Assessment and New Cognitive Assessment results returned in the response

• If there is a candidate found with a completed Behavioral Assessment + no or pending Cognitive Assessment:

  • IsExistingCandidate = true,

  • No Behavioral Assessment sent

  • Cognitive Assessment will be sent or resent

  • Completed Behavioral Assessment results and pending Cognitive Assessment results included in the response

• If there is a candidate found with a completed Cognitive Assessment + no or pending Behavioral Assessment:

  • IsExistingCandidate = true

  • No Cognitive Assessment sent

  • Behavioral Assessment will be sent or resent

  • Completed Cognitive Assessment results and pending Behavioral Assessment results included in the response

• If a there is a candidate found with no completed results:

  • IsExistingCandidate = true

  • Behavioral Assessment (if requested) and Cognitive Assessment (if requested) will be sent

  • Pending Behavioral Assessment and Cognitive Assessment results included in the response

• If there is a candidate found and their details differ from the request body the following would be updated if different:

  • firstName

  • lastName

  • middleName

  • gender

  • isBookmarked

  • email - Only if found by an externalPersonId match

  • externalPersonId - Only if found by an email match

  • jobId - Note this would update the Behavioral Job Fit and Cognitive Job Fit Scores. The Candidate would then appears under the new job association within the PI software.