Used to onboard companies to a partner exclusive API
Partner Restricted
Partner Onboarding endpoints are restricted to assessment providers that have signed a Paylocity technology partnership agreement. Please reach out to [email protected] if you would like to discuss partnership opportunities.
The Partner Onboarding API enables Paylocity to capture the status of a customer who wants to onboard with a technology partner integration.
The table below explains the order and service statuses with the relevant definitions for partners.
| Status | Definition |
|---|---|
| InProgress | New account: This status should be sent when the Paylocity customer has filled out the application form on your web application and submitted it for your team’s review and contracting conversations have begun. Existing account: For a customer which has an existing account, you may skip sending this status if they are using their existing login credentials. It can also be used for existing clients if additional conditions need to be completed before the integration can be initiated on the partner's side. |
| Approved | New account: This status should be sent when you have approved the account request in your application. This status is what allows the customer access to the integration. Existing account: This status should be sent when the existing login credentials have been verified successfully. |
| Rejected | New/Existing account - This status should be sent when the application for an account has been rejected. Note: Do not use this status to indicate the mutual customer offboarding/churning off from your platform. |
| Suspended | Existing account. Use this status to indicate that the mutual customer has offboarded for your platform. This status will keep the integration active, allowing any in progress orders to be updated but not allowing any new orders to be placed (background checks and assessments). |