--- updatedAt: 2026-05-11T22:22:56.000Z agentTools: siteIndex: https://developer.paylocity.com/llms.txt projectIndex: https://developer.paylocity.com/integrations/llms.txt --- # Upsert Onboarding Status > 🚧 Partner Restricted > All background check API endpoints are restricted to background check providers that have signed a Paylocity technology partnership agreement. [Please reach out to our team](https://www.paylocity.com/contact/partner-form/) if you would like to discuss partnership opportunities. **Summary Description** This endpoint upserts the status of the integration with companyId specified in the body **Use Cases** - Partner receives a new client intake form and sends the ‘in progress’ status to Paylocity - Partner and client already have an existing relationship, partner sends the ‘approved’ status for client to have access to ordering in the recruiting UI - Client initiates a new client intake form. Client and partner decide not to move forward with the relationship. Partner sends the ‘rejected’ status # OpenAPI definition ```json { "openapi": "3.0.4", "info": { "title": "Background Check API", "version": "v1" }, "servers": [ { "url": "dc1demogwext.paylocity.com" } ], "paths": { "/compliance/v1/companies/b6001/clientOnboarding/status": { "post": { "tags": [ "Client Onboarding" ], "summary": "Upsert Onboarding Status", "description": "> 🚧 Partner Restricted\n> All background check API endpoints are restricted to background check providers that have signed a Paylocity technology partnership agreement. [Please reach out to our team](https://www.paylocity.com/contact/partner-form/) if you would like to discuss partnership opportunities.\n\n**Summary Description**\n\nThis endpoint upserts the status of the integration with companyId specified in the body\n\n**Use Cases**\n\n- Partner receives a new client intake form and sends the ‘in progress’ status to Paylocity\n- Partner and client already have an existing relationship, partner sends the ‘approved’ status for client to have access to ordering in the recruiting UI \n- Client initiates a new client intake form. Client and partner decide not to move forward with the relationship. Partner sends the ‘rejected’ status \n", "x-explorer-enabled": false, "operationId": "ComplianceClientOnboardingStatusUpsert", "parameters": [ { "name": "testMode", "in": "header", "description": "If true all responses are mocked and generated randomly", "schema": { "type": "boolean" }, "example": false }, { "name": "Authorization", "in": "header", "description": "Authorization token. Ex. Bearer ...", "required": true, "schema": { "type": "string" }, "example": "Bearer " } ], "requestBody": { "description": "The onboarding details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientOnboardingUpsertRequest" } } } }, "responses": { "200": { "description": "Returns details of the upsert operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientOnboardingUpsertResponse" } } } }, "400": { "description": "Bad Request Error - Returns the details of the error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericErrorResponse" }, "examples": { "UnsupportedXmlContentType": { "summary": "The API only supports JSON, but XML was provided.", "value": { "correlationId": "unsupported-media-type-xml-correlation-id", "value": { "code": "UNSUPPORTED_MEDIA_TYPE", "message": "The request content type is not supported." }, "count": 1, "values": [ { "fields": "Content-Type: application/xml", "code": "UNSUPPORTED_MEDIA_TYPE", "message": "The request content type is not supported." } ] } }, "MissingContentTypeHeader": { "summary": "The Content-Type header is missing or empty.", "value": { "correlationId": "unsupported-media-type-missing-header-correlation-id", "value": { "code": "UNSUPPORTED_MEDIA_TYPE", "message": "The request content type is not supported." }, "count": 1, "values": [ { "fields": "Content-Type", "code": "UNSUPPORTED_MEDIA_TYPE", "message": "The request content type is not supported." } ] } } } } } }, "401": { "description": "Unauthorized" }, "415": { "description": "Unsupported Media Type - Returns the details of the error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericErrorResponse" }, "examples": { "UnsupportedXmlContentType": { "summary": "The API only supports JSON, but XML was provided.", "value": { "correlationId": "unsupported-media-type-xml-correlation-id", "value": { "code": "UNSUPPORTED_MEDIA_TYPE", "message": "The request content type is not supported." }, "count": 1, "values": [ { "fields": "Content-Type: application/xml", "code": "UNSUPPORTED_MEDIA_TYPE", "message": "The request content type is not supported." } ] } }, "MissingContentTypeHeader": { "summary": "The Content-Type header is missing or empty.", "value": { "correlationId": "unsupported-media-type-missing-header-correlation-id", "value": { "code": "UNSUPPORTED_MEDIA_TYPE", "message": "The request content type is not supported." }, "count": 1, "values": [ { "fields": "Content-Type", "code": "UNSUPPORTED_MEDIA_TYPE", "message": "The request content type is not supported." } ] } } } } } } } } } }, "components": { "schemas": { "ClientOnboardingUpsertRequest": { "type": "object", "properties": { "companyId": { "type": "string", "description": "The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity. \n **Allowable Values:**\n 9 char max", "nullable": true, "example": " A00123" }, "status": { "enum": [ "InProgress", "Approved", "Rejected", "Suspended" ], "type": "string", "description": "The status to indicate the onboarding stage for a customer where the account form was filled up and is currently under review by your team.", "nullable": true, "example": "InProgress" } }, "additionalProperties": false, "description": "The onboarding request." }, "ClientOnboardingUpsertResponse": { "type": "object", "properties": { "upsertResult": { "$ref": "#/components/schemas/UpsertResultDto" } }, "additionalProperties": false, "description": "Onboarding Response" }, "ErrorDto": { "type": "object", "properties": { "code": { "type": "string", "description": "Error code associated with the error.", "nullable": true }, "message": { "type": "string", "description": "Descriptive message detailing the error.", "nullable": true } }, "additionalProperties": false }, "GenericErrorResponse": { "type": "object", "properties": { "correlationId": { "type": "string", "description": "A unique identifier used for tracing and correlation purposes.", "nullable": true }, "value": { "$ref": "#/components/schemas/ErrorDto" }, "count": { "type": "integer", "description": "Gets the count of items in the Values list.", "format": "int32", "nullable": true, "readOnly": true }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationErrorDto" }, "description": "A list of items.", "nullable": true } }, "additionalProperties": false }, "UpsertResultDto": { "type": "object", "properties": { "inserted": { "type": "boolean", "description": "True if it was inserted, false if it was updated" }, "updated": { "type": "boolean", "description": "True if it was updated, false if it was inserted" } }, "additionalProperties": false, "description": "Upsert response" }, "ValidationErrorDto": { "type": "object", "properties": { "code": { "type": "string", "description": "Error code associated with the error.", "nullable": true }, "message": { "type": "string", "description": "Descriptive message detailing the error.", "nullable": true }, "fields": { "type": "string", "description": "A string detailing the fields involved in the validation error.", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "CC JWT Authorization header using the bearer scheme", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [] } ] } ```