---
title: "BackgroundCheck (People)"
description: "Background Checks for a Person"
---

> Documentation Index
> Fetch the complete documentation index at: https://planningcenterkit.mackenly.com/llms.txt
> Use this file to discover all available pages before exploring further.

# BackgroundCheck (People)

Background Checks for a Person

| Property | Value |
| --- | --- |
| Product | [People](/reference/people/) (`pco.people`, API version `2026-10-05`) |
| Resource type | `BackgroundCheck` |
| TypeScript | `People.BackgroundCheck`, attributes `People.BackgroundCheckAttributes`, schema `People.BackgroundCheckSchema` |
| Planning Center path | `/people/v2/background_checks` |
| Planning Center docs | [BackgroundCheck](https://api.planningcenteronline.com/docs/apps/people/versions/2026-10-05/vertices/background_check) |

## How to reach it

| Client path | Returns | Filters | Create |
| --- | --- | --- | --- |
| `pco.people.background_checks` | Collection | `awaiting_applicant`, `canceled`, `complete_clear`, `complete_not_clear`, `current`, `expired`, `expired_invitation`, `needs_review`, `not_expired`, `report_processing` | No |
| `pco.people.people.id(personId).background_checks` | Collection | `awaiting_applicant`, `canceled`, `complete_clear`, `complete_not_clear`, `current`, `expired`, `expired_invitation`, `needs_review`, `not_expired`, `report_processing` | Yes |

From a collection, `.id(backgroundCheckId)` addresses one BackgroundCheck: `pco.people.background_checks.id(backgroundCheckId)`. Collections support [`where`, `include`, `order`, and pagination](/guides/querying/); single resources have `get()`.

## Attributes

On `People.BackgroundCheckAttributes`. Every resource also has `id` and `type` (`'BackgroundCheck'`) next to its attributes.

| Name | Type | Description |
| --- | --- | --- |
| `completed_at` | `string \| null` | Returns `null` until background check reaches a completed status. When creating completed background checks, leave blank to use current date and time. |
| `current` | `boolean \| null` |  |
| `expires_on` | `string \| null` | Leave blank to use organization's expiration policy |
| `note` | `string \| null` |  |
| `report_url` | `string \| null` | Must be an absolute, percent-encoded `http` or `https` URL. This URL should require authentication |
| `status` | `string \| null` | Possible values: `awaiting_applicant`, `expired_invitation`, `report_processing`, `needs_review`, `complete_clear`, `complete_not_clear`, `canceled` |
| `status_updated_at` | `string \| null` |  |

## Relationships and includes

Side-load with `include()` (or `get({ include })`) and read with `related(resource, name)`: `created_by`, `person`.

| Relationship | Type | To | Includable |
| --- | --- | --- | --- |
| `created_by` | To one | [Person](/reference/people/person/) | Yes |
| `person` | To one | [Person](/reference/people/person/) | Yes |

## Querying

### Where

`where(field, value)` for equality; `where(field, op, value)` with the operators listed.

| Field | Value type | Operators |
| --- | --- | --- |
| `expires_on` | `string \| Date` | `gt`, `gte`, `lt`, `lte` |
| `status_updated_at` | `string \| Date` | `gt`, `gte`, `lt`, `lte` |

### Order

`order(...)` accepts these fields, ascending, or descending with a `-` prefix: `expires_on`, `status_updated_at`.

### Filters

`filter(...)` names depend on the edge you query through:

| Edge | Filters |
| --- | --- |
| `pco.people.background_checks` | `awaiting_applicant`, `canceled`, `complete_clear`, `complete_not_clear`, `current`, `expired`, `expired_invitation`, `needs_review`, `not_expired`, `report_processing` |
| `background_checks` on [Person](/reference/people/person/) | `awaiting_applicant`, `canceled`, `complete_clear`, `complete_not_clear`, `current`, `expired`, `expired_invitation`, `needs_review`, `not_expired`, `report_processing` |

## Edges

Follow these from one BackgroundCheck, `ref = pco.people.background_checks.id(backgroundCheckId)`:

| Edge | Leads to | Returns | Filters | Create |
| --- | --- | --- | --- | --- |
| `ref.created_by` | [Person](/reference/people/person/) | Collection |  | No |
| `ref.person` | [Person](/reference/people/person/) | Collection |  | No |

## Writing

| Property | Value |
| --- | --- |
| Create | Yes, `create()` on `background_checks` on [Person](/reference/people/person/) |
| Update | Yes, `update()` on a reference |
| Delete | Yes, `delete()` on a reference |

### Create attributes

Typed as `People.BackgroundCheckSchema['create']`.

| Attribute | Type |
| --- | --- |
| `completed_at` | `string \| null` |
| `expires_on` | `string \| null` |
| `note` | `string \| null` |
| `report_url` | `string \| null` |
| `status` | `string \| null` |

### Update attributes

Typed as `People.BackgroundCheckSchema['update']`.

| Attribute | Type |
| --- | --- |
| `expires_on` | `string \| null` |
| `note` | `string \| null` |
| `report_url` | `string \| null` |
| `status` | `string \| null` |

See [Writing data](/guides/writing-data/).

## Example

```ts
import type { People } from '@mackenly/planningcenterkit';

const page = await pco.people.background_checks.order('expires_on').perPage(25).list();
const items: People.BackgroundCheck[] = page.data;
```

Source: https://planningcenterkit.mackenly.com/reference/people/background-check/index.mdx
