Update a user

curl --request PATCH \
  --url https://prod.truv.com/v1/users/{user_id}/ \
  --header 'Content-Type: application/json' \
  --header 'X-Access-Client-Id: <api-key>' \
  --header 'X-Access-Secret: <api-key>' \
  --data '
{
  "external_user_id": "12345",
  "email": "john.doe@example.com",
  "phone": "+14155554193"
}
'

import requests

url = "https://prod.truv.com/v1/users/{user_id}/"

payload = {
    "external_user_id": "12345",
    "email": "john.doe@example.com",
    "phone": "+14155554193"
}
headers = {
    "X-Access-Client-Id": "<api-key>",
    "X-Access-Secret": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'X-Access-Client-Id': '<api-key>',
    'X-Access-Secret': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    external_user_id: '12345',
    email: 'john.doe@example.com',
    phone: '+14155554193'
  })
};

fetch('https://prod.truv.com/v1/users/{user_id}/', 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/users/{user_id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'external_user_id' => '12345',
    'email' => 'john.doe@example.com',
    'phone' => '+14155554193'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://prod.truv.com/v1/users/{user_id}/"

	payload := strings.NewReader("{\n  \"external_user_id\": \"12345\",\n  \"email\": \"john.doe@example.com\",\n  \"phone\": \"+14155554193\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-Access-Client-Id", "<api-key>")
	req.Header.Add("X-Access-Secret", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://prod.truv.com/v1/users/{user_id}/")
  .header("X-Access-Client-Id", "<api-key>")
  .header("X-Access-Secret", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"external_user_id\": \"12345\",\n  \"email\": \"john.doe@example.com\",\n  \"phone\": \"+14155554193\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod.truv.com/v1/users/{user_id}/")

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

request = Net::HTTP::Patch.new(url)
request["X-Access-Client-Id"] = '<api-key>'
request["X-Access-Secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"external_user_id\": \"12345\",\n  \"email\": \"john.doe@example.com\",\n  \"phone\": \"+14155554193\"\n}"

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

{
  "id": "24d7e80942ce4ad58a93f70ce4115f5c",
  "external_user_id": "12345",
  "created_at": "2022-05-04T11:30:00Z",
  "updated_at": "2022-05-04T12:00:00Z",
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@example.com",
  "phone": "+14155554193",
  "ssn": "*****3333"
}

{
  "error": {
    "code": "incorrect_parameters",
    "message": "Incorrect request parameters",
    "extra": {
      "invalid-params": [
        {
          "field": "access_token",
          "message": "This field is required."
        }
      ]
    }
  }
}

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

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

PATCH

users

{user_id}

Update a user

curl --request PATCH \
  --url https://prod.truv.com/v1/users/{user_id}/ \
  --header 'Content-Type: application/json' \
  --header 'X-Access-Client-Id: <api-key>' \
  --header 'X-Access-Secret: <api-key>' \
  --data '
{
  "external_user_id": "12345",
  "email": "john.doe@example.com",
  "phone": "+14155554193"
}
'

import requests

url = "https://prod.truv.com/v1/users/{user_id}/"

payload = {
    "external_user_id": "12345",
    "email": "john.doe@example.com",
    "phone": "+14155554193"
}
headers = {
    "X-Access-Client-Id": "<api-key>",
    "X-Access-Secret": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'X-Access-Client-Id': '<api-key>',
    'X-Access-Secret': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    external_user_id: '12345',
    email: 'john.doe@example.com',
    phone: '+14155554193'
  })
};

fetch('https://prod.truv.com/v1/users/{user_id}/', 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/users/{user_id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'external_user_id' => '12345',
    'email' => 'john.doe@example.com',
    'phone' => '+14155554193'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://prod.truv.com/v1/users/{user_id}/"

	payload := strings.NewReader("{\n  \"external_user_id\": \"12345\",\n  \"email\": \"john.doe@example.com\",\n  \"phone\": \"+14155554193\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-Access-Client-Id", "<api-key>")
	req.Header.Add("X-Access-Secret", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://prod.truv.com/v1/users/{user_id}/")
  .header("X-Access-Client-Id", "<api-key>")
  .header("X-Access-Secret", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"external_user_id\": \"12345\",\n  \"email\": \"john.doe@example.com\",\n  \"phone\": \"+14155554193\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod.truv.com/v1/users/{user_id}/")

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

request = Net::HTTP::Patch.new(url)
request["X-Access-Client-Id"] = '<api-key>'
request["X-Access-Secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"external_user_id\": \"12345\",\n  \"email\": \"john.doe@example.com\",\n  \"phone\": \"+14155554193\"\n}"

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

{
  "id": "24d7e80942ce4ad58a93f70ce4115f5c",
  "external_user_id": "12345",
  "created_at": "2022-05-04T11:30:00Z",
  "updated_at": "2022-05-04T12:00:00Z",
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@example.com",
  "phone": "+14155554193",
  "ssn": "*****3333"
}

{
  "error": {
    "code": "incorrect_parameters",
    "message": "Incorrect request parameters",
    "extra": {
      "invalid-params": [
        {
          "field": "access_token",
          "message": "This field is required."
        }
      ]
    }
  }
}

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

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

Authorizations

X-Access-Client-Id

string

header

required

Client ID

X-Access-Secret

string

header

required

Client Access Key

Path Parameters

user_id

string

required

Body

application/json

external_user_id

string

External user id.

Maximum string length: 512

Example:

"12345"

string<email>

User's email.

Example:

"john.doe@example.com"

phone

string

User's phone number.

Example:

"+14155554193"

Response

string

required

read-only

Unique identifier of the user.

Maximum string length: 32

Example:

"24d7e80942ce4ad58a93f70ce4115f5c"

external_user_id

string | null

required

External user id.

Maximum string length: 512

Example:

"12345"

created_at

string<date-time>

required

read-only

Timestamp when the user was created.

Example:

"2022-05-04T11:30:00Z"

updated_at

string<date-time>

required

read-only

Timestamp when the user was updated last time.

Example:

"2022-05-04T12:00:00Z"

first_name

string | null

First name of the user.

Maximum string length: 128

Example:

"John"

last_name

string | null

Last name of the user.

Maximum string length: 128

Example:

"Doe"

string<email> | null

User's email.

Maximum string length: 254

Example:

"john.doe@example.com"

phone

string | null

User's phone number in E.164 format (+ followed by the country code and number).

Maximum string length: 16

Example:

"+14155554193"

ssn

string | null

User's SSN, masked. Only the last 4 digits are visible — the leading digits are replaced with * (for example *****3333). When only the last 4 digits are on file, the value is fully masked (****).

Example:

"*****3333"

⌘I

API Reference

Platform

Income & Employment

Financial Accounts

Document Processing

Direct Deposit Switch

Insurance Verification

Update a user

Authorizations

Path Parameters

Body

Response