Sign in

v1

latestOpenAPI 3.0.42026-07-2481154567.6 KB
Client Onboarding

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 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
post/compliance/v1/companies/b6001/clientOnboarding/status

Headers

testModeboolean

If true all responses are mocked and generated randomly

Authorizationstring required

Authorization token. Ex. Bearer ...

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

status'InProgress' | 'Approved' | 'Rejected' | 'Suspended' nullable

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",
  "status": "InProgress"
}

Response

Returns details of the upsert operation