Create a new profile criminal check. Unlike Instant Criminal Checks, results is an array of matched identities (profiles) with their own nested records, rather than a flat records array -- so a customer can first review which identity matched before drilling into its records.
Beta: Profile Criminal Checks are in beta and not yet generally available.
Profile vs inline PII: Submit either a profile_id or inline PII/address fields—not both. Combining profile_id with name fields, address, addresses, or other PII returns 400 Bad Request (validation_error: "request must only contain a profile_id, or other fields"). Empty address: {} or addresses: [] count as supplied address parameters and cannot be paired with profile_id.
The request body for creating a new profile criminal check.
Use either inline PII fields or profile_id—not both. See the POST /profile_criminal_checks operation for details.
Create a profile criminal check using inline PII.
Provide first_name and last_name (without full_name).
- profile_criminal_check_request_from_pii
- profile_criminal_check_request_from_profile
curl -i -X POST \
'https://api.checkrtrust.com/v1/profile_criminal_checks?include%5B%5D=profile' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"first_name": "Marcus",
"last_name": "Williams",
"dob": "19880315"
}'Created. When the product has usage limits configured, the response includes X-RateLimit-Limit, X-RateLimit-Remaining, and optionally X-RateLimit-Expires.
A universally unique identifier (UUID) in standard format.
An ISO 8601 formatted date-time string.
An ISO 8601 formatted date-time string.
Always person for this product -- profile_criminal_check has no address-based search path.
A reference identifier for linking related records. Limited to 64 alphanumeric characters, underscores, and hyphens.
Array of matched identities (profiles), each with its own nested records. Empty array when no identity matched at all, or when every matched identity scored below the effective minimum match score (the account's configured minimum, or this request's score_threshold override) -- a below-threshold match is excluded entirely, not included with records: []. A matched profile that clears the score threshold but has all of its records excluded (by a ruleset applied on the request, or by de-duplication) still appears here, with records as an empty array -- the identity match itself remains reportable even when nothing survived filtering. Sorted by match_confidence_level's underlying score, descending -- the best match is always first. Capped at the request's limit (default 10, max 20). This ordering is a stable contract you can rely on: matched profiles are not otherwise individually identifiable (no profile_id is exposed), so position in this array is the only way to refer to a specific match (e.g. "the 1st match").
- profile criminal check with profile id
- profile criminal check with profile object
{ "profile_id": "2b8313e8-4efd-45a1-b578-952b8313e890" }