Identity

The identity includes details about the user's identity data, such as the user's name, address, contact information, etc. The information about the user is connected to the link_id of one of Truv's possible product types.

Attributes

The attributes of the Identity:

AttributeTypeDescription
idstringThe Unique Id of the user
created_atstringThe user's identity info was retrieved first time (ISO 8601)
updated_atstringThe user's identity info was retrieved last time (ISO 8601)
first_namestringThe first name of the user
last_namestringThe last name of the user
full_namestringThe full name of the user
middle_initialsstringThe middle initials of the user
emailstringThe user's email address
ssnstringThe social security number of the user
date_of_birthdateThe user's date of birth
home_addressobjectThe user's home address
streetstringThe street on which the user's home is located
citystringThe city in which the user's home is located
statestringThe state in which the user's home is located
zipstringThe zip code to which the user's home belongs
countrystringThe country in which the user's home is located

Endpoints

Available endpoint list for Identity:

Endpoint
Get Identity - GET/link/{link_id}/identity

Sample Object

The example object returned by the Get Identity 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"
  }
}