Partially update a profile. Only the fields you send are changed; omitted fields keep their current values. This is how you add or correct details such as driver_license_number and driver_license_state on a profile you then reference by profile_id in a check request. PUT is not supported.
The fields to change on an existing profile. Omitted fields are left unchanged.
Set to true to declare that the subject does not have a middle name.
Mutually exclusive with a non-empty middle_name: the API rejects requests that supply both a present middle_name and no_middle_name: true. An empty or null middle_name with no_middle_name: true is allowed. A non-empty middle_name may be supplied with no_middle_name: false.
Allowed with full_name: full_name and no_middle_name may be sent together. That is not the same as supplying middle_name — when the flag is true, parsing stores only a first name and surname, and any token the parser would have treated as a middle name is folded into the last name (for example full_name: "John Quincy Doe" becomes first name John and last name Quincy Doe, with middle_name empty).
Setting this to true clears a middle name already stored on a referenced profile. Supplying a non-empty middle_name without this field sets no_middle_name to false. When true, products that perform criminal-record identity matching exclude records with a middle name, narrowing matches to subjects with no middle name on record. When supplied with profile_id, the value is persisted to the referenced profile (same account-scoped profile the check is created against). Leave as false (or omit) if unsure.
The full name of the person. Must not be combined with first_name, middle_name, or last_name.
A phone number in the form +[country code][number including area code]. (E.164 format). Please note that U.S. phone numbers have a country code of "1" so all U.S. phone numbers ought to start with "+1". A U.S. number supplied in national format (for example "(415) 555-0123") is normalized to E.164 on write. If the value cannot be parsed as a valid phone number, the API returns a 400 with a validation_error.
A US Social Security Number in XXX-XX-XXXX format. Hyphens are optional.
A US postal address supplied in a request (for example on check create or profile create/update). When this object is present, street, city, state, and zip_code are required.
Request only. Array of addresses supplied by the caller. Index 0 is the primary address. When the property is provided, at least one address entry is required. Maximum 30 addresses. For check requests, records may be matched against any address in the array. The singular address field remains supported for backwards compatibility and maps to the primary address.
An identifier of your choice, if you wish to use one. Limited to 64 alphanumeric characters, underscores, and hyphens.
A driver license number. The format depends on the issuing state.
- Checkr Trust APIhttps://api.checkrtrust.com/v1/profiles/{profile_id}
curl -i -X PATCH \
https://api.checkrtrust.com/v1/profiles/2b8313e8-b578-45a1-4efd-952b8313e890 \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"email": "john.smith@example.com",
"driver_license_number": "D1234567",
"driver_license_state": "CA"
}'OK
Identifier of an existing profile containing search criteria.
The full name of the person. Must not be combined with first_name, middle_name, or last_name. May be combined with no_middle_name on create/update; when that flag is true, parsing stores only a first name and surname (any middle token is folded into the last name).
Set to true to declare that the subject does not have a middle name.
Mutually exclusive with a non-empty middle_name: the API rejects requests that supply both a present middle_name and no_middle_name: true. An empty or null middle_name with no_middle_name: true is allowed. A non-empty middle_name may be supplied with no_middle_name: false.
Allowed with full_name: full_name and no_middle_name may be sent together. That is not the same as supplying middle_name — when the flag is true, parsing stores only a first name and surname, and any token the parser would have treated as a middle name is folded into the last name (for example full_name: "John Quincy Doe" becomes first name John and last name Quincy Doe, with middle_name empty).
Setting this to true clears a middle name already stored on a referenced profile. Supplying a non-empty middle_name without this field sets no_middle_name to false. When true, products that perform criminal-record identity matching exclude records with a middle name, narrowing matches to subjects with no middle name on record. When supplied with profile_id, the value is persisted to the referenced profile (same account-scoped profile the check is created against). Leave as false (or omit) if unsure.
Date of birth in the form YYYYMMDD. Must be a valid date and cannot be in the future. If invalid, the API returns a 400 with a validation_error pointing to /dob.
A phone number in the form +[country code][number including area code]. (E.164 format) A U.S. number supplied in national format (for example "(415) 555-0123") is normalized to E.164 on write. If invalid, the API returns a 400 with a validation_error.
The phone country calling code supplied for a reverse phone verification (for example, "1" or "54").
A US Social Security Number in XXX-XX-XXXX format. Hyphens are optional.
A US postal address stored on a profile and returned in responses. zip_code is optional: it is returned only when a ZIP was supplied for the address, and is absent otherwise.
Addresses stored on the profile. Index 0 is the primary address. Maximum 30 addresses. Addresses that differ only by a missing ZIP are merged, keeping the one with the ZIP.
An identifier of your choice, if you wish to use one. Limited to 64 alphanumeric characters, underscores, and hyphens.
{ "id": "2b8313e8-4efd-45a1-b578-952b8313e890", "full_name": "string", "first_name": "string", "middle_name": "string", "no_middle_name": false, "last_name": "string", "dob": "19950401", "phone": "+14155552671", "country_code": "string", "email": "john.doe@example.com", "ssn": "XXX-XX-6789", "address": { "street": "123 Main St", "city": "Frankfort", "state": "CA", "zip_code": "94105", "country": "US" }, "addresses": [ { … } ], "custom_id": "my-custom-id-123", "driver_license_state": "CA", "driver_license_number": "D1234567" }