Skip to main content
GET
/
v1
/
links
/
{link_id}
/
identity
Retrieve an identity
curl --request GET \
  --url https://prod.truv.com/v1/links/{link_id}/identity/ \
  --header 'X-Access-Client-Id: <api-key>' \
  --header 'X-Access-Secret: <api-key>'
{
  "first_name": "John",
  "last_name": "Doe",
  "home_address": {
    "street": "1 Morgan Ave",
    "city": "Los Angeles",
    "state": "CA",
    "zip": "90210",
    "country": "US"
  },
  "id": "48427a36d43c4d5aa6324bc06c692456",
  "created_at": "2022-06-07T15:00:00.000Z",
  "updated_at": "2022-06-30T15:00:00.000Z",
  "full_name": "John Doe",
  "middle_initials": "K",
  "email": "john.doe@example.com",
  "ssn": "123456789",
  "date_of_birth": "1992-03-03T00:00:00.000Z"
}

Authorizations

​
X-Access-Client-Id
string
header
required

Client ID

​
X-Access-Secret
string
header
required

Client Access Key

Path Parameters

​
link_id
string
required

Link ID

Response

Person's identity information

​
first_name
string
required

First name

Example:

"John"

​
last_name
string
required

Last name

Example:

"Doe"

​
home_address
object
required

Home address

​
id
string

ID of the object

Example:

"48427a36d43c4d5aa6324bc06c692456"

​
created_at
string

Person's identity info was retrieved first time (ISO 8601)

Example:

"2022-06-07T15:00:00.000Z"

​
updated_at
string

Person's identity info was retrieved last time (ISO 8601)

Example:

"2022-06-30T15:00:00.000Z"

​
full_name
string

Full name

Example:

"John Doe"

​
middle_initials
string | null

Middle initials

Example:

"K"

​
email
string<email> | null

Email address

Example:

"john.doe@example.com"

​
ssn
string

Social security number (Full or last 4 digits)

Example:

"123456789"

​
date_of_birth
string<date>

Date of birth

Example:

"1992-03-03T00:00:00.000Z"