Get identity verification

Request

Get a single identity verification with a given id

Security

get-bearer-token-using-oauth2

Path

identity_verification_idstring, (uuid)required

the uuid identifying the identity verification

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

Query

include[]Array of strings

Embed the profile in the response in place of profile_id.

Items Value	Description
profile	Embeds the full profile object in place of `profile_id`.

Examples:

Single value

include[]=["profile"]

unmask_ssnboolean

For personal_identity_records results, controls whether SSN values in results.people[].ssn are returned in full or masked as XXX-XX-{last4}.

Used by identity verification endpoints only. Driver check endpoints use unmask_ssn instead — see that parameter for precedence rules that apply to results.requested_profile.ssn.

When the product configuration has an explicit unmask_ssn setting (available for personal_identity_records only), that setting takes precedence over this query parameter.

When no product configuration setting exists, false or omitted returns masked SSN values and true returns full SSN values.

If an SSN value is null or empty, it remains null regardless of this parameter.

Default:false

GET

/identity_verifications/{identity_verification_id}

curl -i -X GET \
  'https://api.checkrtrust.com/v1/identity_verifications/2b8313e8-4efd-45a1-b578-952b8313e890?include%5B%5D=profile&unmask_ssn=false' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json

One of:

idstring, (uuid)(uuid)

A universally unique identifier (UUID) in standard format.

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

created_atstring, (date-time)(datetime)

An ISO 8601 formatted date-time string.

Example:"2020-01-01T00:00:00Z"

completed_atstring, (date-time)(datetime)

An ISO 8601 formatted date-time string.

Example:"2020-01-01T00:00:00Z"

resultsidv_result_pii_validation (object) or idv_result_document_verification (object) or idv_result_personal_identity_records (object) or idv_result_reverse_phone (object)

One of:

The structure of results depends on the value of idv_type.

idv_typestring(idv_type)

The type of identity verification to be done.

Default:"pii_validation"

Enum Value	Description
pii_validation	When requesting pii_validation, the result will be returned immediately.
document_verification	When requesting document_verification, the result will be returned asynchronously through a pre-defined webhook.
personal_identity_records	When requesting personal_identity_records, enriched identity information will be returned immediately.
reverse_phone	When requesting reverse_phone, identity information associated with the provided phone number will be returned immediately.

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

A reference identifier for linking related records. Limited to 64 alphanumeric characters, underscores, and hyphens.

Example:"ref-123"

profile_idstring, (uuid)(profile_id)required

Identifier of an existing profile containing search criteria.

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

Response

{
  "profile_id": "2b8313e8-4efd-45a1-b578-952b8313e890"
}