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>'

import requests

url = "https://prod.truv.com/v1/links/{link_id}/identity/"

headers = {
    "X-Access-Client-Id": "<api-key>",
    "X-Access-Secret": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Access-Client-Id': '<api-key>', 'X-Access-Secret': '<api-key>'}
};

fetch('https://prod.truv.com/v1/links/{link_id}/identity/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://prod.truv.com/v1/links/{link_id}/identity/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Access-Client-Id: <api-key>",
    "X-Access-Secret: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://prod.truv.com/v1/links/{link_id}/identity/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Access-Client-Id", "<api-key>")
	req.Header.Add("X-Access-Secret", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://prod.truv.com/v1/links/{link_id}/identity/")
  .header("X-Access-Client-Id", "<api-key>")
  .header("X-Access-Secret", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod.truv.com/v1/links/{link_id}/identity/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Access-Client-Id"] = '<api-key>'
request["X-Access-Secret"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "first_name": "John",
  "last_name": "Doe",
  "id": "48427a36d43c4d5aa6324bc06c692456",
  "created_at": "2022-06-07T15:00:00Z",
  "updated_at": "2022-06-30T15:00:00Z",
  "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"
  }
}

{
  "error": {
    "code": "authentication_failed",
    "message": "No such token"
  }
}

{
  "error": {
    "code": "not_authenticated",
    "message": "Authentication credentials were not provided."
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Requested object not found."
  }
}

GET

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>'

import requests

url = "https://prod.truv.com/v1/links/{link_id}/identity/"

headers = {
    "X-Access-Client-Id": "<api-key>",
    "X-Access-Secret": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Access-Client-Id': '<api-key>', 'X-Access-Secret': '<api-key>'}
};

fetch('https://prod.truv.com/v1/links/{link_id}/identity/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://prod.truv.com/v1/links/{link_id}/identity/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Access-Client-Id: <api-key>",
    "X-Access-Secret: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://prod.truv.com/v1/links/{link_id}/identity/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Access-Client-Id", "<api-key>")
	req.Header.Add("X-Access-Secret", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://prod.truv.com/v1/links/{link_id}/identity/")
  .header("X-Access-Client-Id", "<api-key>")
  .header("X-Access-Secret", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod.truv.com/v1/links/{link_id}/identity/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Access-Client-Id"] = '<api-key>'
request["X-Access-Secret"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "first_name": "John",
  "last_name": "Doe",
  "id": "48427a36d43c4d5aa6324bc06c692456",
  "created_at": "2022-06-07T15:00:00Z",
  "updated_at": "2022-06-30T15:00:00Z",
  "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"
  }
}

{
  "error": {
    "code": "authentication_failed",
    "message": "No such token"
  }
}

{
  "error": {
    "code": "not_authenticated",
    "message": "Authentication credentials were not provided."
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Requested object not found."
  }
}

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

Maximum string length: 50

Example:

"John"

last_name

string

required

Last name

Maximum string length: 50

Example:

"Doe"

string

ID of the object

Maximum string length: 32

Example:

"48427a36d43c4d5aa6324bc06c692456"

created_at

string

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

Example:

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

updated_at

string

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

Example:

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

full_name

string | null

Full name

Maximum string length: 256

Example:

"John Doe"

middle_initials

string | null

Middle initials

Maximum string length: 50

Example:

"K"

string<email> | null

Email address. Normalized to lowercase.

Maximum string length: 254

Example:

"john.doe@example.com"

ssn

string | null

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.

Pattern: ^(\d{4}|\d{9})$

Example:

"123456789"

date_of_birth

string<date> | null

Date of birth

Example:

"1992-03-03"

home_address

object | null

Home address

Show child attributes

Identity Webhook Events The Pay Statements object

⌘I

API Reference

Platform

Income & Employment

Financial Accounts

Document Processing

Direct Deposit Switch

Insurance Verification

Retrieve an identity

Authorizations

Path Parameters

Response