Packages

Packages are bundles of background check types that you configure in the dashboard. When ordering a report, you specify a package ID to determine which checks are run.

GET/v1/packages

List Packages

Returns all packages configured for your account.

Query Parameters

Parameter	Type	Description
page	integer	Page number (default: 1)
per_page	integer	Results per page, max 100 (default: 25)

Example Request

curl

curl https://api.coreverify.com/v1/packages \
  -H "Authorization: Bearer sk_live_your_key"

Example Response

200 OK

{
  "data": [
    {
      "id": "pkg_standard_criminal",
      "name": "Standard Criminal",
      "description": "SSN trace, national criminal search, and sex offender registry check",
      "checkTypes": ["ssn_trace", "criminal_national", "sex_offender"],
      "turnaroundDays": 1,
      "priceCents": 2500,
      "active": true,
      "createdAt": "2024-01-10T00:00:00Z"
    },
    {
      "id": "pkg_enhanced",
      "name": "Enhanced",
      "description": "Comprehensive package including employment and education verification",
      "checkTypes": [
        "ssn_trace",
        "criminal_national",
        "criminal_county",
        "sex_offender",
        "employment_verification",
        "education_verification"
      ],
      "turnaroundDays": 3,
      "priceCents": 7500,
      "active": true,
      "createdAt": "2024-01-10T00:00:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total": 4,
    "total_pages": 1
  }
}

GET/v1/packages/:id

Retrieve a Package

Returns the full details of a single package including all included check types.

Example Request

curl

curl https://api.coreverify.com/v1/packages/pkg_enhanced \
  -H "Authorization: Bearer sk_live_your_key"

Example Response

200 OK

{
  "data": {
    "id": "pkg_enhanced",
    "name": "Enhanced",
    "description": "Comprehensive package including employment and education verification",
    "checkTypes": [
      {
        "type": "ssn_trace",
        "label": "SSN Trace",
        "description": "Verifies SSN and returns address history"
      },
      {
        "type": "criminal_national",
        "label": "National Criminal Search",
        "description": "Searches national criminal database"
      },
      {
        "type": "criminal_county",
        "label": "County Criminal Search",
        "description": "Searches county courthouse records for the past 7 years"
      },
      {
        "type": "sex_offender",
        "label": "Sex Offender Registry",
        "description": "Checks national sex offender registries"
      },
      {
        "type": "employment_verification",
        "label": "Employment Verification",
        "description": "Verifies employment history provided by candidate"
      },
      {
        "type": "education_verification",
        "label": "Education Verification",
        "description": "Verifies highest degree claimed by candidate"
      }
    ],
    "turnaroundDays": 3,
    "priceCents": 7500,
    "active": true,
    "createdAt": "2024-01-10T00:00:00Z",
    "updatedAt": "2024-01-10T00:00:00Z"
  }
}

Check Type Reference

The following check types are available to include in packages.

Type	Description
ssn_trace	SSN validation and address history lookup
criminal_national	Multi-jurisdictional national criminal database search
criminal_county	County courthouse record search (7-year lookback)
criminal_federal	Federal court record search
sex_offender	National sex offender public registry search
global_watchlist	OFAC, terrorist watchlist, and sanctions checks
employment_verification	Verifies employer, title, and dates of employment
education_verification	Verifies degree, institution, and graduation year
mvr	Motor vehicle record (driving history) check
credit	Credit history report (FCRA-compliant)