Upsert onboarding status

post https://dc1demogwext.paylocity.com/compliance/v1/companies/b6001/clientOnboarding/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 Techpartnerships@paylocity.com 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

Responses

401

Unauthorized

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://dc1demogwext.paylocity.com/compliance/v1/companies/b6001/clientOnboarding/status \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
 
1
{
2
  "upsertResult": {
3
    "inserted": true,
4
    "updated": true
5
  }
6
}

200Returns details of the upsert operation

400Bad Request Error - Returns the details of the error

415Unsupported Media Type - Returns the details of the error