Client Onboarding

Upsert Onboarding Status

🚧 Partner Restricted

The Partner Onboarding API is only available to approved partners who have signed a Paylocity Technology Partnership Agreement. If you are not yet a partner and are interested, please reach out to our team to discuss partnership opportunities.

Summary Description

The new Partner Onboarding API is designed to enable our partners to onboard customers through our Paylocity Marketplace-initiated workflow. Approved partners will utilize the API to provision a client onto a specific integration. This API provides an endpoint that allows partners to upsert the status of the integration, using the Paylocity companyId specified in the request body. Partners can update the companyOnboardingStatus to one of four options: InProgress, Approved, Rejected or Suspended. If approved the partner will be able to sync the requested client data through the API.

put/apiHub/security/v1/companies/b6001/companyOnboardingStatuses

Request

Base URL
dc1demogwext.paylocity.com (relative, and the document’s source URL is not known)
URL
dc1demogwext.paylocity.com/apiHub/security/v1/companies/b6001/companyOnboardingStatuses
Auth
none declared

Headers

testModeboolean

If true all responses are mocked and generated randomly.

Request body

companyIdstring nullable

The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity.  Allowable Values: 9 char max

onboardingStatus'InProgress' | 'Approved' | 'Rejected' | 'Suspended'

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.

Example request

{
  "companyId": " A00123",
  "onboardingStatus": "Approved"
}

Response

Created - Resource has been created.