Upsert Screening Packages [Batch] | Paylocity

curl -X POST https://api.paylocity.com/compliance/v1/companies/companyId/backgroundCheck/screeningPackages \
     -H "testMode: <boolean>" \
     -H "Accept: application/json" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "packages": [
    {
      "packageId": "<string>",
      "isActive": "<boolean>",
      "packageSummary": "<string>",
      "packageName": "<string>",
      "services": [
        {
          "serviceName": "<string>",
          "serviceSummary": "<string>"
        },
        {
          "serviceName": "<string>",
          "serviceSummary": "<string>"
        }
      ],
      "price": {
        "value": "<double>",
        "currency": "<string>"
      },
      "billingCode": "<string>",
      "isInternational": "<boolean>"
    },
    {
      "packageId": "<string>",
      "isActive": "<boolean>",
      "packageSummary": "<string>",
      "packageName": "<string>",
      "services": [
        {
          "serviceName": "<string>",
          "serviceSummary": "<string>"
        },
        {
          "serviceName": "<string>",
          "serviceSummary": "<string>"
        }
      ],
      "price": {
        "value": "<double>",
        "currency": "<string>"
      },
      "billingCode": "<string>",
      "isInternational": "<boolean>"
    }
  ]
}'

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

Bulk Upsert information about screening packages

Use Cases

Partner wants to send over multiple screening packages for a client, can be when onboarding a new client, or can be when client adds new packages to their company
Partner wants to make bulk changes to screening packages to make them either active or inactive for a client
Partner wants to update the prices of a client’s screening packages
Partner wants to bulk add services to a packages
Partner wants to add a billing code to correlate to a specific BGC package

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

companyIdstringRequired

Paylocity company identifier (COID): up to 9 alphanumeric characters for the target company.

Request

Request payload for this operation. See the official endpoint documentation for required fields and allowable values.

Response

Successful response

Errors

401

Unauthorized Error

Authentication

Path parameters

Headers

Request

Response

Errors