1. Candidate Selected for Assessment 

A candidate typically is selected to take an assessment in an ATS when one of these occur:

• Candidate submits a completed online application for a job marked as requiring an assessment 
• Recruiter manually performs an action within the ATS software to assign an assessment to a candidate

The PI platform does not automatically enforce upon an integration that each person is sent only one assessment if they apply for multiple jobs. It will allow your integration logic to create many duplicate persons with the same name and email address if this possibility is not considered. Avoiding duplication must be enforced by the integration program logic itself. When a candidate reaches a point where an assessment would be expected, the integration logic must first check for an existing assessment and decide whether to request a new assessment or use an existing one. Additional considerations may apply to your integration goals as outlined in the remainder of this section.

1a. Search for Existing Assessment Taker and Any Assessments

• Use the candidate's details to determine whether the candidate already has completed the required assessment(s) 
• • Existing ATS data referring to a previously completed assessment
  • Existing assessment data in the PI system obtained through an API call using unique candidate data such as email address or candidate ID from the ATS system stored in the externalPersonId field. See GET peopleandjobs

  GET /api/v2/peopleandjobs?$search=somename%40mymail.com

  or 

  GET /api/v2/peopleandjobs?

     $filter=peopleAndJobsSearchResult%2FassessmentUser%2FexternalPersonId%20eq%20'a75be8a5e5a5'

1b. Use Any Completed Assessment Results

If the candidate has already taken all required assessments, no new order should be required. Instead, the existing assessment data should be retrieved and stored according to the current integration design. The assessmentId values returned from the peopleandjobs call above can be used in any API methods relating to the assessment, and the assessmentUserId can be used in any API methods relating to the person.

If the candidate has an existing complete assessment but you will be using the Job Fit / Match Scoring features of PI, it may be necessary to update the existing person data with a current PI Job name so that the existing behavioral and cognitive assessment results will be compared with the correct PI Job rather than whatever PI Job may have been assigned previously. The API method to use for this PATCH v1\persons\{id}

Example using CURL (line breaks added):

curl -X PATCH --header 'Content-Type: application/json'
 --header 'Accept: application/json'
 --header 'api-key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
 -d '{ \ 
   "associatedPositionTitle": "Programmer" \ 
 }' 'https://pi.predictiveindex.com/api/v1/persons/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'

1c. Resend Pending, Expired or Aborted Assessment Invitation

If the candidate has been previously assigned an assessment, there are various options for what to do next based on the assessmentState property of the existing assessment: 

When using PATCH or POST methods detailed below to respond to expired or aborted assessments by sending new email invitations, it is often desirable to send an explanatory message to the email recipient explaining what is happening. To do this, define values for the following two properties in the JSON being passed:

• subject - The email subject line to be used in the new email invitation. If omitted, the original subject line will be re-used.
• message - The custom message to be included in the new email invitation. If omitted, the original message will be used.

PATCH behavioralassessments/{id} - To update an existing Behavioral assessment, the PATCH verb is used instead of the POST verb, the assessmentId must be passed as a part of the request URL and the body of the request must contain JSON with any properties to be updated. See PATCH behavioralassessment/{id}.

• resendAssessment - To resend the assessment invitation email, pass the parameter resendAssessment with a value of 1. 
• expirationDateTime - Available only in the PATCH behavioralassessment method, use this to set a new expiration date (e.g. "2019-02-24"). If you want to specify a UTC time: "2019-02-24T04:00:00.000Z".

curl -X PATCH --header 'Content-Type: application/json'
 --header 'Accept: application/json'
 --header 'api-key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
 -d '{  "resendAssessment": true, "expirationDateTime":"2019-02-24", 
        "subject":"The Predictive Index Behavioral Assessment - Extended",
         "message":"You have been given extra time to complete the Behavioral Assessment." 
 }' 'https://pi.predictiveindex.com/api/v1/behavioralassessments/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'

curl -X POST --header 'Content-Type: application/json'
 --header 'Accept: application/json'
 --header 'api-key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
 -d '{  "assessmentUserGuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" 
        "subject":"The Predictive Index Cognitive Assessment - Extended",
        "message":"You have been given extra time to complete the Cognitive Assessment."        "assessmentStatusWebHook": "https://webhook.site/xxxx11114e46", \ 
        "notifyAssessmentAvailableUsingEmail": 1, \ 
        "externalId": "1234503002", \ 
 }' 'https://pi.predictiveindex.com/api/v2/cognitiveassessments'

1d. Update Existing Person with New Details

Changing Job using Job Title (uses api/v1)

Maybe you have obtained a list of possible jobs from the /api/v3/jobs API method and stored them in a drop-down list in the UI and your UI doesn't support list values that are different from their display values, and now you wish to use the name property from that drop-down to assign the job to the current person.

curl -X PATCH --header 'Content-Type: application/json'
 --header 'Accept: application/json'
 --header 'api-key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
 -d '{  
   "associatedPositionTitle": "Quality Assurance Engineer"  
 }' 'https://pi.predictiveindex.com/api/v1/persons/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'

Changing Job using Job ID (uses api/v3)

Maybe you have obtained the list of possible jobs from the /api/v3/jobs API method and stored them in a drop-down list in the UI, and now you wish to use the jobId property from that drop-down to assign that jobId to the candidate in question.

curl -X PATCH --header 'Content-Type: application/json'
 --header 'Accept: application/json'
 --header 'api-key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
 -d '{  
   "associatedJobId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"  
 }' 'https://pi.predictiveindex.com/api/v3/persons/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'

Changing folderPath (uses api/v1)

Maybe the person is applying for a job in a different department than the previous application so you want to put their existing assessment information into a folder that is accessible by the hiring team for the latest application.

curl -X PATCH --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'api-key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
 -d '{    "folderPath": "\\Some Client Account\\Some Folder\\Another Folder"  }' 'https://pi.predictiveindex.com/api/v1/persons/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'

Changing externalPersonId (uses api/v3)

Maybe you need to update the external person ID because the existing data was created before you integrated with the current external system and need to assign an external person ID for the first time, or PI was integrated with a different external system previously so the new external person ID must be stored.

curl -X PATCH --header 'Content-Type: application/json'
 --header 'Accept: application/json'
 --header 'api-key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
 -d '{ \ 
   "externalPersonId": "SOMEnewEXTID1234" \ 
 }' 'https://pi.predictiveindex.com/api/v3/persons/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'

1e. Example Logic Handling Existing Assessments along with Jobs and Folders

When dealing with a situation where a candidate applies for multiple jobs and the integration is designed to assign jobs and folders based on which job application is submitted, the integration logic must handle these changes. When the first assessment is ordered for the first job application, a folder will be chosen. When the second job application is completed and the integration logic decides what to do, it is an open question whether you want it to move the existing assessment/candidate to a new folder for the second job or to leave it in the original location. Either is a possibility, but each path requires different logic to be constructed and possibly different rules to govern the action. 

For example, if the applicant applies for 4 jobs in one day, you might assume the first job they applied for is their top choice and the other three are "backup" jobs. This assumption would lead you to leave the assessment/person in the original (first) folder. On the other hand, if an applicant applies for one job and then a month later for a second job, you might assume the second job is now their top choice, leading you to move the assessment/person to the folder for the second job. To sort this out, your integration may need to include logic something like this:

 if an assessment exists for this person (using email address to search) {
    if assessmentDateTime (sent) is more than 30 days ago {
         PATCH person: assign new job (associatedPositionTitle)
            assign new folder location (folderPath) corresponding to new job application
    } else {
         no change - leave assessment in original folder location with existing job
    }
    if the assessment is expired (assessmentState > 40) {
        resend: BA = PATCH assessmentId + resendAssessment; CA = POST using assessmentUserId 
    }
 } else {
    POST a new assessment creating a new person with new job title and placed in new folder
 }

2. ATS Integration Orders PI Assessment (POST)

When ordering an assessment via the PI API, you must first determine which API method to use based on which type of assessment you are ordering:

• Behavioral Assessment (aka BA or "the PI") = POST behavioralassessments
• Cognitive Assessment (aka CA or "the PLI") = POST cognitiveassessments

You must pass as the POST data a JSON object containing parameters that express several facts and decisions:

• Identify the Assessment Taker - there are two ways you can specify which person is supposed to take the assessment:
• • Create a new PI person by providing new information about the person, causing a new PI Person object to be created along with the assessment. You cannot specify assessmentUserGuid if providing name and email data.
  • • firstName, middleName(optional), lastName
    • email
    • externalPersonId(optional) - this is usually a unique identifier from the ATS system up to 71 characters in length. If you pass this value, an action that attempts to create a new PI Person, and that value already exists for another PI Person, you will receive an error and the POST will fail. This is why it is wise to check for an existing person in step 1 above before reaching this step.
    • associatedPositionTitle(optional) - this field must match a Job Target name from the PI software. If this is defined as a parameter and the Job in PI software has a target defined for behavioral pattern and/or cognitive score, then the results of the assessment will include Job Match scores, a very powerful piece of data to use for identifying strong match candidates, even by people who do not yet fully understand the PI behavioral pattern graphs. To obtain a list of all current Job Target names, you can call the API method GET jobs and use from the results the selected name property to assign to associatedPositionTitle.
      
    • gender(optional number or string) - Male (1) or Female (2) - controls the pronouns used in report language. If no gender is specified for a person, gender must be specified at the time Behavioral reports are generated (NOTE: The Behavioral Report is available in a gender-neutral form for en-US languageLocale only. See notes in Part B - Section 2 below.)
    • personType (optional) - Candidate or Employee or Other. The PI software system includes an ability to manage persons and their assessment data according to the type of person they are to the organization. Setting the personType to Candidate for job applicants is wise so that all such people can be managed as a group. However, once a person has been hired, it is also wise to change their personType to Employee so they will no longer be managed like a Candidate.
  • Refer to an existing PI person by providing the assessmentUserGuid of an existing PI Person to which the assessment should be linked. If you provide this parameter value, you cannot also provide values for the parameters used to define a new PI person as described above. Note: The value given to input parameter assessmentUserGuid should be the output property named assessmentUserId from the results of other API methods such as GET peopleandjobs or GET behavioralassessments, etc.
• Control whether and how the PI system notifies the Assessment Taker via email
• • notifyAssessmentAvailableUsingEmail- 0 (No - default) or 1 (Yes) - If you wish the PI system to notify the user of the assessment, you may also wish to provide an email subject and introductory body content using the following two parameters:
  • subject (optional) - email subject line to be used instead of the default value defined in the PI account settings.
  • message (optional) - introduction shown at the very beginning of the email message body to be used instead of the default value defined in the PI account settings.
• Override the Assessment Owner and Contact Info - Assessments ordered via the API are automatically "owned" by the user account whose API Key is in use for the integration. See Generating an API Key for more details. The first and last name, email address, and phone of that user are the default person shown in the invitation email and assessment website as the contact point if assessment takers have any questions. That person is also shown as being responsible for the assessment when displayed in the PI software. If you wish to attribute the assessment to a different person -- a recruiter or hiring coordinator, for example -- you must specify any parameters you wish to be used in place of the default settings:
• • administeredByFirstName, administeredByLastName
  • administeredByEmail - must be used when name parameters are used
  • administeredByPhone- optional
  • administeredByCompanyName - required for Cognitive, not available for Behavioral
• Actions to Perform After Assessment
• • assessmentStatusWebHook (optional) - define a listener URL on your integration system that will expect a POST of several attributes for each status change for a given assessment. Use this to signal your integration that the assessment is complete and ready for results to be read from the PI system. The attributes sent include assessmentId, externalId, assessmentState, and assessmentSource. See Assessment Status WebHooks for details
  • notifyAssessmentAvailableUsingEmail (optional) - use this to cause the PI system to send an email invitation to the assessment taker containing a link to the assessment and instructions. This notification message is sent using default subject and introductory message text as defined in the client settings in the PI software unless you also specify the following override parameters:
  • • subject
    • message
• • autoSendPIReportToAssessmentTaker (optional, Behavioral only) - 0 (default) = No, 1 = Yes. Some clients wish to send a copy of the assessment results report directly to the assessment taker.
  • sendCognitiveAssessmentOnCompletion (optional, Behavioral only) - 0 (default) = No, 1 = Yes. If you wish to have your assessment taker take both Behavioral and Cognitive assessments, pass this parameter in POST behavioralassessments to automatically trigger the sending of a Cognitive assessment email invitation after the assessment taker completes the Behavioral assessment. This parameter is only available in the POST behavioralassessment method.
    WARNING: This feature does not cause a notification to be sent to the assessmentStatusWebHook  upon completion of the Cognitive Assessment. If your integration requires a Cognitive webhook notification, do no tuse this parameter but instead make a separate call to POST cognitiveassessments to order it passing as a parameter the assessmentUserId obtained from the response of the POST behavioralassessments call.
  • redirectURL (optional, Behavioral only) - a web address to which the assessment taker's browser should be redirected after completing the assessment. This can be used, for example, to show the user a web page explaining next steps. Or if the assessment is being presented to the assessment taker as part of the application process, a redirect might be used to take the user back to the next stage of the online application.
• Other Properties
• • externalId (optional) - This field provides an opportunity to store a unique identifier with the assessment being ordered up to 71 characters in length. This is different from externalPersonId mentioned above which is associated with the person. If an externalId is defined for an assessment and an assessmentStatusWebHook URL has been defined, this value is included in the POST variables sent from the PI system to the listener at that URL.
  • folderPath or folderGuid (optional) - The PI system always stores assessment takers into a folder within a structure controlled by the client. The default folder is determined on a client account level and can be overridden by a setting in the user account who owns the API Key. Those folder settings are ignored if a different folder is specified using folder-related parameters. Since permissions can be attached to folders by client admins, the owner of the API Key used by the integration must have sufficient permissions to access the specified folder. There are two ways to specify a folder into which an assessment taker should be placed, but you can only specify one or the other of these two:
  • • folderPath - a full path to the folder as displayed in the details area of the chosen folder within the PI system settings. Backslashes in the path must be doubled to escape them for use in JSON: "\\Example Company\\Some Folder"
    • folderGuid - the PI system GUID for the given folder. This parameter may be used to avoid errors caused by spelling changes in the folder names.
  • languageLocale (optional) - PI system will assume that the language for assessments is the same as the default language for the client account. Possible language codes are found here: API Guide - Common
  • customInfo (optional) - an array of fieldName and fieldValue pairs containing any values you choose. WARNING: These fields are deprecated and may not be supported in future versions of the PI software and API.

2a. PI Sending Email

2b. ATS Sending Email

2c. Example POST behavioralassessments

curl -X POST
 --header 'Content-Type: application/json'
 --header 'Accept: application/json' --header 'api-key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
 -d '{ \ 
   "firstName": "Kim", \ 
   "lastName": "Prospect", \ 
   "email": "kim.prospect%40gmail.com", \ 
   "subject": "ACME Corp - Please take Behavioral Assessment", \ 
   "message": "As a part of your job application process, ACME Corp would like you to take this brief assessment to help complete our understanding of you! It only takes about 8 minutes.", \ 
   "administeredByEmail": "trecruiter%40acme.com", \ 
   "administeredByPhone": "800-555-1212", \ 
   "administeredByFirstName": "Terry", \ 
   "administeredByLastName": "Recruiter", \ 
   "associatedPositionTitle": "Sales Manager", \ 
   "gender": "Female", \ 
   "personType": "Candidate", \ 
   "notifyAssessmentAvailableUsingEmail": 1, \ 
   "externalId": "A123456", \ 
   "externalPersonId": "P345678", \    "folderPath": "\\ACME Corp\\Candidates", \
   "languageLocale": "en-US", \
   "assessmentStatusWebHook": "https://someintegrationserver.com/listener/pi-assessment", \
   "redirectURL": "http://acme.com/careers/next-steps", \ 
   "autoSendPIReportToAssessmentTaker": 1  \ 
 }' 
'https://pi.predictiveindex.com/api/v1/behavioralassessments'

Example of Response (HTTP response code 201):

{
  "errorResponse": null,
  "assessmentId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "firstName": "Kim",
  "middleName": null,
  "lastName": "Prospect",
  "email": "kim.prospect@gmail.com",
  "impression": 0,
  "subject": "ACME Corp - Please take Behavioral Assessment",
  "message": "As a part of your job application process, ACME Corp would like you to take this brief assessment to help complete our understanding of you! It only takes about 8 minutes.",
  "assessmentDateTime": "2018-08-15T19:49:27.6886775Z",
  "expirationDateTime": "2018-08-23T12:00:00.0000000Z",
  "assessmentCompletedDateTime": null,
  "administeredByEmail": "trecruiter@acme.com",
  "administeredByPhone": "800-555-1212",
  "administeredByFirstName": "Terry",
  "administeredByLastName": "Recruiter",
  "scoringMethod": 1,
  "patternNumber": null,
  "descriptiveReportUrl": "",
  "associatedPositionTitle": "Marketing Director",
  "associatedPositionImageUrl": "/0?format=PNG",
  "folderId": null,
  "folderPath": "\\ACME Corp\\Candidates",
  "patternFullUrl": "",
  "patternSelfUrl": "",
  "gender": 2,
  "personType": "Candidate",
  "isDeleted": 0,
  "assessmentState": 10,
  "assessmentStatusWebHook": "https://someintegrationserver.com/listener/pi-assessment",
  "notifyAssessmentAvailableUsingEmail": 1,
  "externalId": "A123456",
  "externalPersonId": "P345678",
  "assessmentUserId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "assessmentUrl": "https://assess.predictiveindex.com/Account/LoginPi?a=XXXXXXXX8igigYxTzbfZQzR3Eeq2vrjn3xg2EesVjZuRWLScteGbnQQNVyKa20Kn&lang=en-US",
  "assessmentPassword": "XXXXXXXX",
  "descriptiveReportPageUrl": "",
  "personPageUrl": "https://pi.predictiveindex.com/Browse/PersonDetails?assessmentUserId=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "redirectURL": "http://acme.com/careers/next-steps",
  "selfSigmaScore": null,
  "selfConceptSigmaScore": null,
  "synthesisSigmaScore": null,
  "positionSigmaScore": null,
  "customFields": null,
  "customReports": null,
  "latestWebhookStatus": null,
  "autoSendPIReportToAssessmentTaker": 1,
  "sendCognitiveAssessmentOnCompletion": 0
}
        

3. ATS Integration Receives Response from POST

4. Candidate Receives Assessment Email

5. Candidate Follows Link and Takes PI Assessment

The link whose value is defined in response property assessmentUrl is encoded to include a unique assessment identifier, a username, and a password that will allow immediate access to the assessment. Once the assessment is complete, the link cannot be used again. 

6. Assessment End

7. PI Optionally Calls ATS Integration Assessment Status Webhook Listener

See Webhooks for more detail on how they work. 

If the assessmentState is 40 (Complete), the next step would be to use the assessmentId in a call to GET behavioralassessments/{id} and/or possibly other methods to obtain all result details, as described in Part B:

Part B - Obtain Assessment Results Link to Additional Results

Diagram B:

1. Obtain Assessment Results (GET)

curl -X GET
 --header 'Accept: application/json'
 --header 'api-key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
 'https://pi.predictiveindex.com/api/v1/behavioralassessments/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'

2. Receive and Store Assessment Details

Behavioral Assessment Results - GET behavioralassessments/{assessmentId}

curl -X GET
 --header 'Accept: application/json'
 --header 'api-key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
 'https://pi.predictiveindex.com/api/v1/behavioralassessments/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'

Reference Pattern Details - GET behavioralassessments/{assessmentId}/guidebook

curl -X GET
 --header 'Accept: application/json'
 --header 'api-key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
 'https://pi.predictiveindex.com/api/v2/behavioralassessments/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/guidebook?languageLocale=en-US'

curl -X GET
 --header 'Accept: application/json'
 --header 'api-key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
 'https://pi.predictiveindex.com/api/v2/cognitiveassessments/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'

curl -X GET --header 'Accept: application/json' --header 'api-key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' 'https://pi.predictiveindex.com/api/v1/persons/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'

curl -X POST  --header 'Content-Type: application/json'
  --header 'Accept: application/pdf'
  --header 'api-key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'  -d '{  
   "reportLanguage": "en-US",  
   "personsToReportOn": [  
     {  
       "personId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",  
       "gender": "Unknown"  
     }  
   ],  
   "isManagementStyle": true,  
   "isSellingStyle": true,  
   "isInfluencingStyle": false  
 }' 'https://pi.predictiveindex.com/api/v1/persons/PrintBehavioralReports'

curl -X POST  --header 'Content-Type: application/json' 
  --header 'Accept: application/pdf' 
  --header 'api-key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'  -d '{  
   "reportLanguage": "en-US",  
   "personsToReportOn": [  
     "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"  
   ],  
   "showSensitiveInformation": false  
 }' 'https://pi.predictiveindex.com/api/v3/persons/PrintCognitiveReports'

curl -X GET
 --header 'Accept: application/json'
 --header 'api-key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
 'https://pi.predictiveindex.com/api/v2/peopleandjobs/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'

curl -X POST 
 --header 'Content-Type: application/json'
 --header 'Accept: application/pdf'
 --header 'api-key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
 -d '{ 
   "personId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",  
   "jobId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", 
   "guideLanguage": "en-US"  
 }' 
 'https://pi.predictiveindex.com/api/v3/persons/DownloadInterviewGuide'

Person Snapshot Report - GET persons/downloadPersonSnapshotReport

The Person Snapshot report is a useful summary of a person's behavioral pattern intended for sharing with others who may not have any PI training or understanding. To obtain this report, pass an assessmentUserId in the parameter personId, a filename (without the file extension), and languageLocale (optional) in an API call like this (line breaks added to what should be one single URL):

curl -X GET --header 'Accept: application/pdf' --header 'api-key: e8c11cd0-4be7-45ce-b1fe-2a051373de75' 'https://pi.predictiveindex.com/api/v3/persons/downloadPersonSnapshotReport?personId=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&fileName=TestPersonPIBehavioralSnapshot&languageLocale=en-US'

The filename passed as a parameter will have a ".pdf" extension added to the response file stream.

3. Assessment Details Link Displayed

4. Recruiter Follows Link

5. Recruiter Views Assessment Details Page