Skip to content

Profiles

Profiles represent a set of Personally Identifiable Information (PII) for a person who will be checked. Profiles can be updated with the latest information for a person and be referenced to generate checks.

Operations

Get profiles

Request

Get a set of profiles

Security
get-bearer-token-using-oauth2
Query
limitinteger, [ 0 .. 999999 ]

limit the number of records returned

Default:10
skipinteger, [ 0 .. 999999 ]

skip a number of records before returning (for paging)

Default:0
curl -i -X GET \
  'https://api.checkrtrust.com/v1/profiles?limit=10&skip=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
Array [
idstring, (uuid)(profile_id)

Identifier of an existing profile containing search criteria.

Example:"2b8313e8-4efd-45a1-b578-952b8313e890"
full_namestring

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).

first_namestring

The first name of the person.

middle_namestring

The middle name of the person. Can be null if not provided.

no_middle_nameboolean(no_middle_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.

Default:false
last_namestring

The last name of the person.

dobstring, = 8 characters(date_string_complete)\d{8}

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.

Example:"19950401"
phonestring(phone_string)^\+[1-9]\d{1,14}$

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.

Example:"+14155552671"
country_codestring

The phone country calling code supplied for a reverse phone verification (for example, "1" or "54").

emailstring, (email)(email_string)

An email address.

Example:"john.doe@example.com"
ssnssn_string (string) or masked_ssn_string (string) or null
One of:

A US Social Security Number in XXX-XX-XXXX format. Hyphens are optional.

string(ssn_string)
addressobject(address_stored)

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.

addressesArray of objects, <= 30 items(addresses_stored)

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.

custom_idstring(custom_id_string)^[a-zA-Z0-9_-]{1,64}$

An identifier of your choice, if you wish to use one. Limited to 64 alphanumeric characters, underscores, and hyphens.

Example:"my-custom-id-123"
driver_license_statestring(state_code)^[A-Z]{2}$

A two-letter US state code.

Example:"CA"
driver_license_numberstring

The driver license number. Format dependent on State.

Example:"D1234567"
]
Response
[
  {
    "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": { … },
    "addresses": [ … ],
    "custom_id": "my-custom-id-123",
    "driver_license_state": "CA",
    "driver_license_number": "D1234567"
  }
]