---
updatedAt: 2026-04-27T15:52:51.000Z
agentTools:
siteIndex: https://developer.paylocity.com/llms.txt
projectIndex: https://developer.paylocity.com/integrations/llms.txt
---
# Upsert Sensitive Data
Sends new or updated employee sensitive data information directly to Paylocity Payroll/HR solution.
# OpenAPI definition
```json
{
"openapi": "3.0.1",
"info": {
"title": "WebLink API",
"description": "For documentation about this API, please visit https://developer.paylocity.com/integrations/reference/weblink-overview",
"contact": {
"email": "webservices@paylocity.com"
},
"version": "v2"
},
"servers": [
{
"url": "https://dc1demogw.paylocity.com/api"
}
],
"paths": {
"/v2/companies/{companyId}/employees/{employeeId}/sensitivedata": {
"put": {
"tags": [
"Sensitive Data"
],
"summary": "Upsert Sensitive Data",
"description": "Sends new or updated employee sensitive data information directly to Paylocity Payroll/HR solution.",
"x-explorer-enabled": false,
"operationId": "Add or update Sensitive Data",
"parameters": [
{
"name": "companyId",
"in": "path",
"description": "The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity.\r\n **Allowable Values:**\r\n 9 char max",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "employeeId",
"in": "path",
"description": "The Paylocity Employee ID. This is a unique value per Paylocity Company ID.\r\n**Allowable Values:**\r\n10 char max",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Sensitive Data Model",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/sensitiveData"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successfully added or updated",
"content": {}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/error"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {}
},
"429": {
"description": "Too Many Requests",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/error"
}
}
}
}
}
},
"security": [
{
"paylocity_auth": [
"WebLinkAPI"
]
}
],
"x-codegen-request-body-name": "json"
}
}
},
"components": {
"schemas": {
"error": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "The name of the field, or property in the request message that contains an error."
},
"message": {
"type": "string",
"description": "The error message."
},
"options": {
"type": "array",
"description": "A list of options associated with this error. These options may indicate valid values for the field, or property that contains an error.",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "The code associated with this option."
},
"description": {
"type": "string",
"description": "The description of the option."
}
},
"description": "The error option model"
}
},
"path": {
"type": "string",
"description": "The JSON path of the field, or property, that contains an error in the request message."
}
},
"description": "The error model"
},
"sensitiveData": {
"type": "object",
"properties": {
"disability": {
"type": "object",
"properties": {
"disability": {
"type": "string",
"description": "Description of employee's disability or accommodation.
Max length: 50"
},
"disabilityClassifications": {
"description": "Add or update employee's disability classifications",
"type": "array",
"items": {
"description": "The disability classifications model",
"type": "object",
"properties": {
"classification": {
"type": "string",
"description": "Indicates the type of disability. This field is only allowed if hasDisability is set to 1=Yes. Values include:
Auditory
Cognitive, learning, and neurological
Physical
Speech
Vision
Prefer not to say
Valid values can be obtained from Company Codes endpoint, codeResource = disabilityClassification"
}
}
}
},
"hasDisability": {
"type": "string",
"description": "Indicates if the employee has a disability. Values include:
0 = No
1 = Yes
2 = Prefer not to say"
}
},
"additionalProperties": false,
"description": "Add or update disability data."
},
"ethnicity": {
"type": "object",
"properties": {
"ethnicity": {
"type": "string",
"description": "Employee's legal ethnicity or race.
A = Asian
B = Black
H = Hispanic
I = American Indian
N = Native Hawaiian or Pacific Islander
T = Two or More Races
W = White
Valid values can be obtained from Company Codes endpoint, codeResource = ethnicity"
},
"ethnicRacialIdentities": {
"description": "Add or update Ethnic Racial Identity",
"type": "array",
"items": {
"description": "The ethnic racial identity model",
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Employee's preferred or chosen ethnicity or race.
Max length: 40."
}
}
}
}
},
"additionalProperties": false,
"description": "Add or update ethnicity data."
},
"gender": {
"type": "object",
"properties": {
"displayPronouns": {
"type": "boolean",
"description": "Specifies whether employee's preferred pronouns will be displayed to co-workers in Community, Directory, etc. Values include:
0 = No
1 = Yes"
},
"genderIdentityDescription": {
"type": "string",
"description": "Employee's preferred or chosen gender identification.
Max length: 40"
},
"identifyAsLegalGender": {
"type": "string",
"description": "Employee's self-identification of legal gender. Numerical values include:
0 = No
1 = Yes
2 = Prefer not to say"
},
"legalGender": {
"type": "string",
"description": "Employee's legal gender. Values include:
M = Male
F = Female
Valid values can be obtained from Company Codes endpoint, codeResource = legalGender"
},
"pronouns": {
"type": "string",
"description": "Employee's preferred or chosen pronouns. Values include:
He / Him / His
She / Her / Hers
They / Them / Theirs
Prefer not to say
Valid values can be obtained from Company Codes endpoint, codeResource = preferredPronouns"
},
"sexualOrientation": {
"type": "string",
"description": "Employee's self-identification of sexual orientation. Values may include values below. Additionally, any custom value may be provided.
Asexual
Gay / Lesbian
Heterosexual / Straight
Pansexual
Queer
Bisexual
Prefer not to say"
}
},
"additionalProperties": false,
"description": "Add or update gender data."
},
"veteran": {
"type": "object",
"properties": {
"isVeteran": {
"type": "string",
"description": "Indicates if the employee is a veteran. Values include:
0 = No
1 = Yes
2 = Prefer not to say"
},
"veteran": {
"type": "string",
"description": "Employee's Veteran Notes
Max length: 50"
}
},
"additionalProperties": false,
"description": "Add or update veteran data."
}
},
"additionalProperties": false,
"description": "The sensitive data model"
}
},
"securitySchemes": {
"paylocity_auth": {
"type": "oauth2",
"flows": {
"clientCredentials": {
"tokenUrl": "https://api.paylocity.com/IdentityServer/connect/token",
"scopes": {
"WebLinkAPI": "Web Link Api"
}
}
}
}
}
},
"x-original-swagger-version": "2.0"
}
```