v4

OpenAPI 3.0.12026-07-3189233676.2 KB

Identity

Retrieve an identity

Get the identity data for the user

get/v1/links/{link_id}/identity/

Response

idstring

ID of the object

created_atstring

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

updated_atstring

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

first_namestring required

First name

last_namestring required

Last name

full_namestring nullable

Full name

middle_initialsstring nullable

Middle initials

emailstring email nullable

Email address. Normalized to lowercase.

ssnstring nullable

Social security number — either the full 9 digits or the last 4 digits, depending on what the data source exposes. Digits only, never formatted with dashes.

date_of_birthstring date nullable

Date of birth

Example response

{
  "id": "48427a36d43c4d5aa6324bc06c692456",
  "created_at": "2022-06-07T15:00:00Z",
  "updated_at": "2022-06-30T15:00:00Z",
  "first_name": "John",
  "last_name": "Doe",
  "full_name": "John Doe",
  "middle_initials": "K",
  "email": "john.doe@example.com",
  "ssn": "123456789",
  "date_of_birth": "1992-03-03",
  "home_address": {
    "street": "1 Morgan Ave",
    "city": "Los Angeles",
    "state": "CA",
    "zip": "90210",
    "country": "US"
  }
}