Early Access (EA)This API is currently in Early Access and available only to approved EA participants. Do not rely on this version for production workloads unless explicitly authorized. If you have any feedback, please share with your designated Early Adoption program representative.
Summary Description
The Create Employee Skill Document Uploads endpoint reserves a document for each file you want to attach to an employee skill and returns a documentKey plus a short-lived upload URL for each one. You upload the file directly to that URL, then attach it to the skill by passing the documentKey to Add Or Renew Employee Skill.
Use Cases
- Attach a scanned certificate or license to an employee's certification record.
- Upload proof of training completion from a learning platform.
Company Set Behavior
Documents are attached to the person's skill assignment, which is shared by all of the person's Employee IDs in the company set.
How Document Upload Works
- Call this endpoint with each file's fileName, fileSizeBytes, and mimeType. No file content is sent to this endpoint.
- Save the documentKey returned for each file. You need it to attach the document to the employee's skill.
- Send each file's bytes to its uploadUrl using uploadHttpMethod. Set Content-Type to the same mimeType, make sure the body is exactly fileSizeBytes, and do not include the Paylocity bearer token. Upload URLs expire shortly after they are issued, so upload right away.
- Call Add Or Renew Employee Skill and pass the saved documentKey values in documentKeys. The skill definition must have allowDocuments = true.
401Unauthorized. The bearer token is missing, invalid, or expired. Request a new access token and try again.
403Forbidden. The token is valid, but the API client is not authorized to access this API or this company.
404Not Found. The Employee ID was not found in the company.
429Too Many Requests. The API client exceeded the rate limit of 3 requests per second. Wait briefly, then retry using a backoff strategy.