List counter parties
curl --request GET \
--url https://production.hifi.com/v3/users/{userId}/counter-parties \
--header 'Authorization: Bearer <token>'import requests
url = "https://production.hifi.com/v3/users/{userId}/counter-parties"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://production.hifi.com/v3/users/{userId}/counter-parties', 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/users/{userId}/counter-parties",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://production.hifi.com/v3/users/{userId}/counter-parties"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://production.hifi.com/v3/users/{userId}/counter-parties")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://production.hifi.com/v3/users/{userId}/counter-parties")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "cpty_7dLpR2mNpXwZ7bV1aQz3x",
"userId": "usr_3Kf9dQ2mNpXwZ7bV1aLcs",
"type": "INDIVIDUAL",
"firstName": "Jane",
"lastName": "Doe",
"phoneNumber": "+14155552671",
"email": "jane.doe@example.com",
"taxId": "123-45-6789",
"dateOfBirth": "1990-01-15",
"nationality": "USA",
"address": {
"addressLine1": "123 Main Street",
"city": "New York",
"stateProvinceRegion": "NY",
"postalCode": "10001",
"country": "USA"
},
"status": "ACTIVE",
"createdAt": "2026-07-01T10:30:00.000Z",
"updatedAt": "2026-07-01T10:30:00.000Z"
}
],
"pagination": {
"hasMore": false,
"startCursor": "cpty_7dLpR2mNpXwZ7bV1aQz3x",
"endCursor": "cpty_7dLpR2mNpXwZ7bV1aQz3x"
}
}{
"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": "INTERNAL_SERVER_ERROR",
"message": "An internal server error occurred"
}Counter Parties
List counter parties
List all counter parties for a user. Supports cursor-based pagination and filtering by type.
GET
/
v3
/
users
/
{userId}
/
counter-parties
List counter parties
curl --request GET \
--url https://production.hifi.com/v3/users/{userId}/counter-parties \
--header 'Authorization: Bearer <token>'import requests
url = "https://production.hifi.com/v3/users/{userId}/counter-parties"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://production.hifi.com/v3/users/{userId}/counter-parties', 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/users/{userId}/counter-parties",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://production.hifi.com/v3/users/{userId}/counter-parties"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://production.hifi.com/v3/users/{userId}/counter-parties")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://production.hifi.com/v3/users/{userId}/counter-parties")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "cpty_7dLpR2mNpXwZ7bV1aQz3x",
"userId": "usr_3Kf9dQ2mNpXwZ7bV1aLcs",
"type": "INDIVIDUAL",
"firstName": "Jane",
"lastName": "Doe",
"phoneNumber": "+14155552671",
"email": "jane.doe@example.com",
"taxId": "123-45-6789",
"dateOfBirth": "1990-01-15",
"nationality": "USA",
"address": {
"addressLine1": "123 Main Street",
"city": "New York",
"stateProvinceRegion": "NY",
"postalCode": "10001",
"country": "USA"
},
"status": "ACTIVE",
"createdAt": "2026-07-01T10:30:00.000Z",
"updatedAt": "2026-07-01T10:30:00.000Z"
}
],
"pagination": {
"hasMore": false,
"startCursor": "cpty_7dLpR2mNpXwZ7bV1aQz3x",
"endCursor": "cpty_7dLpR2mNpXwZ7bV1aQz3x"
}
}{
"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": "INTERNAL_SERVER_ERROR",
"message": "An internal server error occurred"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
ID of the user.
Pattern:
^user_[A-Za-z0-9]+$Query Parameters
default to 10, maximum to 100
Required range:
1 <= x <= 100Return records after this cursor.
Return records before this cursor.
Filter counter parties by type.
Available options:
INDIVIDUAL, BUSINESS ⌘I