Identity

View information and details about the user's identity.

Overview

Identity includes details about the user's personal identifiable information, such as the user's name, address, contact information, and other information.. The information about the user is connected to the link_id of Truv's product types.

Attributes

The values in the table below cover attributes for identity.

AttributeTypeDescription
idstringUnique user ID
created_atstringISO 8601 value for first time retrieving user's identity info
updated_atstringISO 8601 value for last time retrieving user's identity info
first_namestringFirst name
last_namestringLast name
full_namestringFull name
middle_initialsstringMiddle initials
emailstringEmail address
ssnstringSocial Security Number
date_of_birthdateDate of birth
home_addressobjectAddress object

Address object

The values in this table are for the address object of the user.

AttributeTypeDescription
streetstringStreet
citystringCity
statestringState
zipstringZip
countrystringCountry

Endpoint

The item below is the available endpoint for Identity.

Example response

The response below is the JSON object for the endpoint.

{
  "id": "710097b33ec14f898df3644b563430e1",
  "created_at": "2022-08-10T09:30:48.520089Z",
  "updated_at": "2022-08-10T09:30:48.520114Z",
  "first_name": "John",
  "last_name": "Doe",
  "full_name": "John Doe",
  "middle_initials": null,
  "email": "[email protected]",
  "ssn": "221122112",
  "date_of_birth": "1992-03-03",
  "home_address": {
    "zip": "94062",
    "city": "Redwood City",
    "state": "CA",
    "street": "35 Dry Ridge Rd",
    "country": "US"
  }
}