Rippling: Update a background check candidate — request body — body

API reference · Contract 2026-10-28

SDK schema: Update a background check candidate — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Background Check Candidate DTO. Represents a candidate who has been submitted for background check screening. Required on Create (but nullable on read for legacy rows): - email: Required for new candidates, but may be null on read for legacy rows - external_id: Required for new candidates, but may be null on read for legacy rows Optional Fields: - owner_id: May be null if no provider is associated - first_name: May be null if name is not available - last_name: May be null if name is not available - middle_name: May be null if not provided Sensitive Fields: - first_name, last_name, middle_name: Name fields are PII marked as sensitive in the model - These do not require separate OAuth scopes beyond the resource-level scopes (background-check-candidates.read / .read-write) because they are not updating role or worker data, only storing candidate names for background check processing Note: first_name, last_name, and middle_name are NOT filterable. Only external_id, email, created_at, and updated_at support filtering.
email	string	Required within parent	The email address of the candidate. Required on create, but may be null on read for legacy rows.
external_id	string	Required within parent	The provider’s unique identifier for the candidate. Required on create, but may be null on read for legacy rows. Can only be set once (during creation or when null). Cannot be changed after being set.
first_name	string	Optional	The first name of the candidate.
last_name	string	Optional	The last name of the candidate.
middle_name	string	Optional	The middle name of the candidate.