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 [email protected] 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
Body Params

The onboarding details

The onboarding request.

string | null

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

string | null
enum

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.

Allowed:
Headers
boolean

If true all responses are mocked and generated randomly

Responses

401

Unauthorized

Language
Credentials
Header
LoadingLoading

Response
Choose an example:
application/json