HIFI Docs

PATCH

counter-parties

{counterPartyId}

Update a counter party

curl --request PATCH \
  --url https://production.hifi.com/v3/counter-parties/{counterPartyId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userId": "usr_3Kf9dQ2mNpXwZ7bV1aLcs",
  "type": "INDIVIDUAL",
  "firstName": "Jane",
  "lastName": "Smith",
  "phoneNumber": "+14155559999",
  "email": "jane.smith@example.com",
  "dateOfBirth": "1990-01-15",
  "taxId": "123-45-6789",
  "nationality": "USA",
  "address": {
    "addressLine1": "456 Elm Street",
    "city": "New York",
    "stateProvinceRegion": "NY",
    "postalCode": "10002",
    "country": "USA"
  }
}
'

import requests

url = "https://production.hifi.com/v3/counter-parties/{counterPartyId}"

payload = {
    "userId": "usr_3Kf9dQ2mNpXwZ7bV1aLcs",
    "type": "INDIVIDUAL",
    "firstName": "Jane",
    "lastName": "Smith",
    "phoneNumber": "+14155559999",
    "email": "jane.smith@example.com",
    "dateOfBirth": "1990-01-15",
    "taxId": "123-45-6789",
    "nationality": "USA",
    "address": {
        "addressLine1": "456 Elm Street",
        "city": "New York",
        "stateProvinceRegion": "NY",
        "postalCode": "10002",
        "country": "USA"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    userId: 'usr_3Kf9dQ2mNpXwZ7bV1aLcs',
    type: 'INDIVIDUAL',
    firstName: 'Jane',
    lastName: 'Smith',
    phoneNumber: '+14155559999',
    email: 'jane.smith@example.com',
    dateOfBirth: '1990-01-15',
    taxId: '123-45-6789',
    nationality: 'USA',
    address: {
      addressLine1: '456 Elm Street',
      city: 'New York',
      stateProvinceRegion: 'NY',
      postalCode: '10002',
      country: 'USA'
    }
  })
};

fetch('https://production.hifi.com/v3/counter-parties/{counterPartyId}', 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://production.hifi.com/v3/counter-parties/{counterPartyId}",
  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([
    'userId' => 'usr_3Kf9dQ2mNpXwZ7bV1aLcs',
    'type' => 'INDIVIDUAL',
    'firstName' => 'Jane',
    'lastName' => 'Smith',
    'phoneNumber' => '+14155559999',
    'email' => 'jane.smith@example.com',
    'dateOfBirth' => '1990-01-15',
    'taxId' => '123-45-6789',
    'nationality' => 'USA',
    'address' => [
        'addressLine1' => '456 Elm Street',
        'city' => 'New York',
        'stateProvinceRegion' => 'NY',
        'postalCode' => '10002',
        'country' => 'USA'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://production.hifi.com/v3/counter-parties/{counterPartyId}"

	payload := strings.NewReader("{\n  \"userId\": \"usr_3Kf9dQ2mNpXwZ7bV1aLcs\",\n  \"type\": \"INDIVIDUAL\",\n  \"firstName\": \"Jane\",\n  \"lastName\": \"Smith\",\n  \"phoneNumber\": \"+14155559999\",\n  \"email\": \"jane.smith@example.com\",\n  \"dateOfBirth\": \"1990-01-15\",\n  \"taxId\": \"123-45-6789\",\n  \"nationality\": \"USA\",\n  \"address\": {\n    \"addressLine1\": \"456 Elm Street\",\n    \"city\": \"New York\",\n    \"stateProvinceRegion\": \"NY\",\n    \"postalCode\": \"10002\",\n    \"country\": \"USA\"\n  }\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://production.hifi.com/v3/counter-parties/{counterPartyId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"userId\": \"usr_3Kf9dQ2mNpXwZ7bV1aLcs\",\n  \"type\": \"INDIVIDUAL\",\n  \"firstName\": \"Jane\",\n  \"lastName\": \"Smith\",\n  \"phoneNumber\": \"+14155559999\",\n  \"email\": \"jane.smith@example.com\",\n  \"dateOfBirth\": \"1990-01-15\",\n  \"taxId\": \"123-45-6789\",\n  \"nationality\": \"USA\",\n  \"address\": {\n    \"addressLine1\": \"456 Elm Street\",\n    \"city\": \"New York\",\n    \"stateProvinceRegion\": \"NY\",\n    \"postalCode\": \"10002\",\n    \"country\": \"USA\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://production.hifi.com/v3/counter-parties/{counterPartyId}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"userId\": \"usr_3Kf9dQ2mNpXwZ7bV1aLcs\",\n  \"type\": \"INDIVIDUAL\",\n  \"firstName\": \"Jane\",\n  \"lastName\": \"Smith\",\n  \"phoneNumber\": \"+14155559999\",\n  \"email\": \"jane.smith@example.com\",\n  \"dateOfBirth\": \"1990-01-15\",\n  \"taxId\": \"123-45-6789\",\n  \"nationality\": \"USA\",\n  \"address\": {\n    \"addressLine1\": \"456 Elm Street\",\n    \"city\": \"New York\",\n    \"stateProvinceRegion\": \"NY\",\n    \"postalCode\": \"10002\",\n    \"country\": \"USA\"\n  }\n}"

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

{
  "id": "cpty_7dLpR2mNpXwZ7bV1aQz3x",
  "userId": "usr_3Kf9dQ2mNpXwZ7bV1aLcs",
  "type": "INDIVIDUAL",
  "firstName": "Jane",
  "lastName": "Smith",
  "phoneNumber": "+14155559999",
  "email": "jane.smith@example.com",
  "taxId": "123-45-6789",
  "dateOfBirth": "1990-01-15",
  "nationality": "USA",
  "address": {
    "addressLine1": "456 Elm Street",
    "city": "New York",
    "stateProvinceRegion": "NY",
    "postalCode": "10002",
    "country": "USA"
  },
  "status": "ACTIVE",
  "createdAt": "2026-07-01T10:30:00.000Z",
  "updatedAt": "2026-07-01T12:00:00.000Z"
}

{
  "type": "VALIDATION_ERROR",
  "message": "One or more fields are invalid or missing.",
  "fields": [
    {
      "code": "invalid_value",
      "message": "Must be a valid email address",
      "field": "email"
    }
  ]
}

{
  "type": "UNAUTHORIZED",
  "message": "Authentication required"
}

{
  "type": "RESOURCE_NOT_FOUND",
  "message": "<string>",
  "fields": [
    {
      "code": "<string>",
      "message": "<string>",
      "field": "<string>"
    }
  ]
}

{
  "type": "INTERNAL_SERVER_ERROR",
  "message": "An internal server error occurred"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

counterPartyId

string

required

Public ID of the counter party (prefixed with cpty_)

Body

application/json

Fields to update on the counter party. Provide the full object for the counter party type; the type field selects which fields apply.

Individual
Business

An individual counter party. Only userId, type, firstName, and lastName are always required; the other fields become required depending on what is later attached (external wallet needs the name only; external account needs phoneNumber, email, dateOfBirth, taxId, taxIdType, nationality, address).

userId

string

required

Public ID of the user this counter party belongs to (prefixed with usr_).

Example:

"usr_3Kf9dQ2mNpXwZ7bV1aLcs"

type

enum<string>

required

Available options:

INDIVIDUAL

Example:

"INDIVIDUAL"

firstName

string

required

Example:

"Jane"

lastName

string

required

Example:

"Doe"

phoneNumber

string

Phone number.

Example:

"+14155552671"

string<email>

Example:

"jane.doe@example.com"

dateOfBirth

string<date>

Date of birth in YYYY-MM-DD format.

Example:

"1990-01-15"

taxId

string

Tax identification number. If the user does not have a tax identification number for valid reasons, please pass nine nines "999999999".

Example:

"123-45-6789"

taxIdType

string

Type of tax identifier (e.g. SSN, ITIN).

Example:

"SSN"

taxIdCountry

string

ISO 3166-1 alpha-3 country that issued the tax ID.

Example:

"USA"

nationality

string

ISO 3166-1 alpha-3 country code.

Example:

"USA"

address

object

Address of the counter party.

Show child attributes

Response

Counter party updated successfully.

A counter party.

string

Public ID of the counter party (prefixed with cpty_).

Example:

"cpty_7dLpR2mNpXwZ7bV1aQz3x"

userId

string

Public ID of the user this counter party belongs to (prefixed with usr_).

Example:

"usr_3Kf9dQ2mNpXwZ7bV1aLcs"

type

enum<string>

Available options:

INDIVIDUAL,

BUSINESS

Example:

"INDIVIDUAL"

category

string

Business category. Present for business counter parties.

Example:

"software"

firstName

string

Present for individual counter parties.

Example:

"Jane"

lastName

string

Present for individual counter parties.

Example:

"Doe"

businessName

string

Present for business counter parties.

Example:

"Acme Corp"

phoneNumber

string

Example:

"+14155552671"

string<email>

Example:

"jane.doe@example.com"

taxId

string

Tax identification number.

Example:

"123-45-6789"

dateOfBirth

string<date> | null

Date of birth. Present for individual counter parties.

Example:

"1990-01-15"

incorporationDate

string<date> | null

Date of incorporation. Present for business counter parties.

Example:

"2015-06-01"

nationality

string

ISO 3166-1 alpha-3 country code. Present for individual counter parties.

Example:

"USA"

address

object

Address of the counter party.

Show child attributes

status

enum<string>

Available options:

ACTIVE,

INACTIVE

Example:

"ACTIVE"

createdAt

string<date-time>

Example:

"2026-07-01T10:30:00.000Z"

updatedAt

string<date-time>

Example:

"2026-07-01T10:30:00.000Z"

⌘I

Update a counter party

curl --request PATCH \
  --url https://production.hifi.com/v3/counter-parties/{counterPartyId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userId": "usr_3Kf9dQ2mNpXwZ7bV1aLcs",
  "type": "INDIVIDUAL",
  "firstName": "Jane",
  "lastName": "Smith",
  "phoneNumber": "+14155559999",
  "email": "jane.smith@example.com",
  "dateOfBirth": "1990-01-15",
  "taxId": "123-45-6789",
  "nationality": "USA",
  "address": {
    "addressLine1": "456 Elm Street",
    "city": "New York",
    "stateProvinceRegion": "NY",
    "postalCode": "10002",
    "country": "USA"
  }
}
'

import requests

url = "https://production.hifi.com/v3/counter-parties/{counterPartyId}"

payload = {
    "userId": "usr_3Kf9dQ2mNpXwZ7bV1aLcs",
    "type": "INDIVIDUAL",
    "firstName": "Jane",
    "lastName": "Smith",
    "phoneNumber": "+14155559999",
    "email": "jane.smith@example.com",
    "dateOfBirth": "1990-01-15",
    "taxId": "123-45-6789",
    "nationality": "USA",
    "address": {
        "addressLine1": "456 Elm Street",
        "city": "New York",
        "stateProvinceRegion": "NY",
        "postalCode": "10002",
        "country": "USA"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    userId: 'usr_3Kf9dQ2mNpXwZ7bV1aLcs',
    type: 'INDIVIDUAL',
    firstName: 'Jane',
    lastName: 'Smith',
    phoneNumber: '+14155559999',
    email: 'jane.smith@example.com',
    dateOfBirth: '1990-01-15',
    taxId: '123-45-6789',
    nationality: 'USA',
    address: {
      addressLine1: '456 Elm Street',
      city: 'New York',
      stateProvinceRegion: 'NY',
      postalCode: '10002',
      country: 'USA'
    }
  })
};

fetch('https://production.hifi.com/v3/counter-parties/{counterPartyId}', 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://production.hifi.com/v3/counter-parties/{counterPartyId}",
  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([
    'userId' => 'usr_3Kf9dQ2mNpXwZ7bV1aLcs',
    'type' => 'INDIVIDUAL',
    'firstName' => 'Jane',
    'lastName' => 'Smith',
    'phoneNumber' => '+14155559999',
    'email' => 'jane.smith@example.com',
    'dateOfBirth' => '1990-01-15',
    'taxId' => '123-45-6789',
    'nationality' => 'USA',
    'address' => [
        'addressLine1' => '456 Elm Street',
        'city' => 'New York',
        'stateProvinceRegion' => 'NY',
        'postalCode' => '10002',
        'country' => 'USA'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://production.hifi.com/v3/counter-parties/{counterPartyId}"

	payload := strings.NewReader("{\n  \"userId\": \"usr_3Kf9dQ2mNpXwZ7bV1aLcs\",\n  \"type\": \"INDIVIDUAL\",\n  \"firstName\": \"Jane\",\n  \"lastName\": \"Smith\",\n  \"phoneNumber\": \"+14155559999\",\n  \"email\": \"jane.smith@example.com\",\n  \"dateOfBirth\": \"1990-01-15\",\n  \"taxId\": \"123-45-6789\",\n  \"nationality\": \"USA\",\n  \"address\": {\n    \"addressLine1\": \"456 Elm Street\",\n    \"city\": \"New York\",\n    \"stateProvinceRegion\": \"NY\",\n    \"postalCode\": \"10002\",\n    \"country\": \"USA\"\n  }\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://production.hifi.com/v3/counter-parties/{counterPartyId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"userId\": \"usr_3Kf9dQ2mNpXwZ7bV1aLcs\",\n  \"type\": \"INDIVIDUAL\",\n  \"firstName\": \"Jane\",\n  \"lastName\": \"Smith\",\n  \"phoneNumber\": \"+14155559999\",\n  \"email\": \"jane.smith@example.com\",\n  \"dateOfBirth\": \"1990-01-15\",\n  \"taxId\": \"123-45-6789\",\n  \"nationality\": \"USA\",\n  \"address\": {\n    \"addressLine1\": \"456 Elm Street\",\n    \"city\": \"New York\",\n    \"stateProvinceRegion\": \"NY\",\n    \"postalCode\": \"10002\",\n    \"country\": \"USA\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://production.hifi.com/v3/counter-parties/{counterPartyId}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"userId\": \"usr_3Kf9dQ2mNpXwZ7bV1aLcs\",\n  \"type\": \"INDIVIDUAL\",\n  \"firstName\": \"Jane\",\n  \"lastName\": \"Smith\",\n  \"phoneNumber\": \"+14155559999\",\n  \"email\": \"jane.smith@example.com\",\n  \"dateOfBirth\": \"1990-01-15\",\n  \"taxId\": \"123-45-6789\",\n  \"nationality\": \"USA\",\n  \"address\": {\n    \"addressLine1\": \"456 Elm Street\",\n    \"city\": \"New York\",\n    \"stateProvinceRegion\": \"NY\",\n    \"postalCode\": \"10002\",\n    \"country\": \"USA\"\n  }\n}"

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

{
  "id": "cpty_7dLpR2mNpXwZ7bV1aQz3x",
  "userId": "usr_3Kf9dQ2mNpXwZ7bV1aLcs",
  "type": "INDIVIDUAL",
  "firstName": "Jane",
  "lastName": "Smith",
  "phoneNumber": "+14155559999",
  "email": "jane.smith@example.com",
  "taxId": "123-45-6789",
  "dateOfBirth": "1990-01-15",
  "nationality": "USA",
  "address": {
    "addressLine1": "456 Elm Street",
    "city": "New York",
    "stateProvinceRegion": "NY",
    "postalCode": "10002",
    "country": "USA"
  },
  "status": "ACTIVE",
  "createdAt": "2026-07-01T10:30:00.000Z",
  "updatedAt": "2026-07-01T12:00:00.000Z"
}

{
  "type": "VALIDATION_ERROR",
  "message": "One or more fields are invalid or missing.",
  "fields": [
    {
      "code": "invalid_value",
      "message": "Must be a valid email address",
      "field": "email"
    }
  ]
}

{
  "type": "UNAUTHORIZED",
  "message": "Authentication required"
}

{
  "type": "RESOURCE_NOT_FOUND",
  "message": "<string>",
  "fields": [
    {
      "code": "<string>",
      "message": "<string>",
      "field": "<string>"
    }
  ]
}

{
  "type": "INTERNAL_SERVER_ERROR",
  "message": "An internal server error occurred"
}

Overview

Endpoints

Update a counter party

Authorizations

Path Parameters

Body

Response