BackgroundCheck - People API

Example Request

curl https://api.planningcenteronline.com/people/v2/background_checks

View in API Explorer →

Example Object

{
  "type": "BackgroundCheck",
  "id": "1",
  "attributes": {
    "completed_at": "2000-01-01T12:00:00Z",
    "current": true,
    "expires_on": "2000-01-01",
    "note": "string",
    "report_url": "string",
    "status": "string",
    "status_updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {
    "person": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    },
    "created_by": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`completed_at`	`date_time`	Returns `null` until background check reaches a completed status. When creating completed background checks, leave blank to use current date and time.
`current`	`boolean`
`expires_on`	`date`	Leave blank to use organization's expiration policy
`id`	`primary_key`
`note`	`string`
`report_url`	`string`	This URL should require authentication
`status`	`string`	Possible values: `awaiting_applicant`, `expired_invitation`, `report_processing`, `needs_review`, `complete_clear`, `complete_not_clear`, `canceled`
`status_updated_at`	`date_time`

Relationships

Name	Type	Association Type	Note
person	Person	to_one
created_by	Person	to_one

Can Include

Parameter	Value	Description	Assignable
include	created_by	include associated created_by	create and update
include	person	include associated person	create and update

Order By

Parameter	Value	Type	Description
order	expires_on	string	prefix with a hyphen (-expires_on) to reverse the order
order	status_updated_at	string	prefix with a hyphen (-statusupdatedat) to reverse the order

Query By

Name	Parameter	Type	Description	Example
expires_on	`where[expires_on]`	date	Leave blank to use organization's expiration policy	`?where[expires_on]=2000-01-01`
status_updated_at	`where[status_updated_at]`	date_time	Query on a specific statusupdatedat	`?where[status_updated_at]=2000-01-01T12:00:00Z`

Pagination

Name	Parameter	Type	Description
per_page	per_page	integer	how many records to return per page (min=1, max=100, default=25)
offset	offset	integer	get results from given offset

Endpoints

Listing

HTTP Method	Endpoint
GET	`/people/v2/background_checks`

Reading

HTTP Method	Endpoint
GET	`/people/v2/background_checks/{id}`

Creating

HTTP Method	Endpoint	Assignable Attributes
POST	`/people/v2/people/{person_id}/background_checks`	note status report_url expires_on completed_at

Updating

HTTP Method	Endpoint	Assignable Attributes
PATCH	`/people/v2/background_checks/{id}`	note status report_url expires_on

Deleting

HTTP Method	Endpoint
DELETE	`/people/v2/background_checks/{id}`

Associations

HTTP Method	Endpoint	Returns	Details	Filter By
GET	`https://api.planningcenteronline.com/people/v2/background_checks/{background_check_id}/created_by`	Person
GET	`https://api.planningcenteronline.com/people/v2/background_checks/{background_check_id}/person`	Person

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/people/v2/background_checks`	Organization		`awaiting_applicant` `canceled` `complete_clear` `complete_not_clear` `current` filter background checks to only those considered "current" `expired` `expired_invitation` `needs_review` `not_expired` `report_processing`
GET	`https://api.planningcenteronline.com/people/v2/people/{person_id}/background_checks`	Person		`awaiting_applicant` `canceled` `complete_clear` `complete_not_clear` `current` filter background checks to only those considered "current" `expired` `expired_invitation` `needs_review` `not_expired` `report_processing`