Skip to content

Identity Verifications

Identity Verifications provide the resulting information relevant to the requested verification for a set of PII. The response will include the IDV type and results.

Operations

Get identity verifications

Request

Get a set of identity verifications

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
include[]Array of strings

Embed the profile in the response in place of profile_id.

Items ValueDescription
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
curl -i -X GET \
  'https://api.checkrtrust.com/v1/identity_verifications?limit=10&skip=0&include%5B%5D=profile&unmask_ssn=false' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
Array [
One of:
]
Response
[
  {
    "profile_id": "2b8313e8-4efd-45a1-b578-952b8313e890"
  }
]