Package

Retrieve a package resource by package type

Retrieve package resource is used to retrieve all active packages for an account.

get/package/{packageType}

Request

  • Base URL
    https://api.accuratebackground.com/v3
  • URL
    https://api.accuratebackground.com/v3/package/{packageType}
  • Auth
    HTTP basic

Path parameters

packageTypestring required

Package type.

Response

Success Response

idstring
packageCodestring
packageNamestring
packageTypestring
titlestring
packagePricenumber
scoringOnboolean
createdstring date-time
createdBystring

Example response

{
  "id": "5e837e24498e441cd59c3fbb",
  "packageName": "Basic Package HQ",
  "packageType": "BASIC_PACKAGE_HQ",
  "packagePrice": 10,
  "products": [
    {
      "productType": "9PK",
      "productTypeDesc": "CUSTOMIZED PACKAGE",
      "country": "US",
      "region": "NA"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.