POST Background Screening Packages

POST Background Screening Packages endpoint enables the provider to send a list of packages to Dayforce. The provider can also send the list of associated billing codes (if any) together.

Note: Packages that aren't part of the request are considered deleted or inactive.

The URL for POST Background Screening Packages uses the following base URL:

https://www.dayforcehcm.com/api/CompanyName/V1/BackgroundScreening/Package

Parameters

ProviderReference parameter type and description

Parameters	Type	Description
ProviderReference*	String	Provider unique identifier

Response Objects

Properties, type and descriptions of response objects

Object Name	Properties	Type	Description
Packages	PackageId*	String	Provider package id
	Name*	String	Package name
	Description	String	Package description
	IncludeRTW	Boolean	Defines whether the package supports Right to Work
	AssociatedBillingCodes	N/A	List of associated billing codes to a package
AssociatedBillingCodes	BillingCodeId*	String	Provider billing code id
	Name	String	Billing code name
	Description	String	Billing code description

Below is a sample response that Dayforce is expecting from the provider:

{
  "ProviderReference": "BS_GENERIC",
    "Packages": [
  {
	 "PackageId": "1",
	 "Name": "Package 1",
	 "Description": "Package 1 Description",
        "IncludeRTW": true,
	 "AssociatedBillingCodes": [
     {
	     "BillingCodeId": "1",
	     "Name": "Billing Code 1",
	     "Description": "Billing Code 1 Description"
     },
     {
	     "BillingCodeId": "2",
	     "Name": "Billing Code 2",
	     "Description": "Billing Code 2 Description"
     }
    ]
   },

   {
				

        "PackageId": "2",
	 "Name": "Package 2",
	 "Description": "Package 2 Description",
	 "AssociatedBillingCodes": [
     {
	     "BillingCodeId": "1",
	     "Name": "Billing Code 1",
	     "Description": "Billing Code 1 Description"
     },
     {
	     "BillingCodeId": "3",
	     "Name": "Billing Code 3",
	     "Description": "Billing Code 3 Description"
     }
    ]
   }
  ]
 }