Create a counterparty that belongs to this client
curl --request POST \
--url https://api.range.org/v2/parties/{id}/counterparties \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"name": "Berlin Bank AG",
"legal_form": "business",
"jurisdiction": "DE",
"address": {
"line1": "Friedrichstraße 1",
"line2": "3. OG",
"city": "Berlin",
"region": "BE",
"postal_code": "10117",
"country": "DE"
},
"is_fi": false,
"tax_ids": [
{
"jurisdiction": "BR",
"scheme": "cnpj",
"value": "12345678000195"
}
],
"notes": "Onboarded via referral",
"persons_of_interest": [
{
"name": "Ada Lovelace",
"role": "director"
}
]
}
'import requests
url = "https://api.range.org/v2/parties/{id}/counterparties"
payload = {
"name": "Berlin Bank AG",
"legal_form": "business",
"jurisdiction": "DE",
"address": {
"line1": "Friedrichstraße 1",
"line2": "3. OG",
"city": "Berlin",
"region": "BE",
"postal_code": "10117",
"country": "DE"
},
"is_fi": False,
"tax_ids": [
{
"jurisdiction": "BR",
"scheme": "cnpj",
"value": "12345678000195"
}
],
"notes": "Onboarded via referral",
"persons_of_interest": [
{
"name": "Ada Lovelace",
"role": "director"
}
]
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Berlin Bank AG',
legal_form: 'business',
jurisdiction: 'DE',
address: {
line1: 'Friedrichstraße 1',
line2: '3. OG',
city: 'Berlin',
region: 'BE',
postal_code: '10117',
country: 'DE'
},
is_fi: false,
tax_ids: [{jurisdiction: 'BR', scheme: 'cnpj', value: '12345678000195'}],
notes: 'Onboarded via referral',
persons_of_interest: [{name: 'Ada Lovelace', role: 'director'}]
})
};
fetch('https://api.range.org/v2/parties/{id}/counterparties', 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://api.range.org/v2/parties/{id}/counterparties",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Berlin Bank AG',
'legal_form' => 'business',
'jurisdiction' => 'DE',
'address' => [
'line1' => 'Friedrichstraße 1',
'line2' => '3. OG',
'city' => 'Berlin',
'region' => 'BE',
'postal_code' => '10117',
'country' => 'DE'
],
'is_fi' => false,
'tax_ids' => [
[
'jurisdiction' => 'BR',
'scheme' => 'cnpj',
'value' => '12345678000195'
]
],
'notes' => 'Onboarded via referral',
'persons_of_interest' => [
[
'name' => 'Ada Lovelace',
'role' => 'director'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <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://api.range.org/v2/parties/{id}/counterparties"
payload := strings.NewReader("{\n \"name\": \"Berlin Bank AG\",\n \"legal_form\": \"business\",\n \"jurisdiction\": \"DE\",\n \"address\": {\n \"line1\": \"Friedrichstraße 1\",\n \"line2\": \"3. OG\",\n \"city\": \"Berlin\",\n \"region\": \"BE\",\n \"postal_code\": \"10117\",\n \"country\": \"DE\"\n },\n \"is_fi\": false,\n \"tax_ids\": [\n {\n \"jurisdiction\": \"BR\",\n \"scheme\": \"cnpj\",\n \"value\": \"12345678000195\"\n }\n ],\n \"notes\": \"Onboarded via referral\",\n \"persons_of_interest\": [\n {\n \"name\": \"Ada Lovelace\",\n \"role\": \"director\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<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.post("https://api.range.org/v2/parties/{id}/counterparties")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Berlin Bank AG\",\n \"legal_form\": \"business\",\n \"jurisdiction\": \"DE\",\n \"address\": {\n \"line1\": \"Friedrichstraße 1\",\n \"line2\": \"3. OG\",\n \"city\": \"Berlin\",\n \"region\": \"BE\",\n \"postal_code\": \"10117\",\n \"country\": \"DE\"\n },\n \"is_fi\": false,\n \"tax_ids\": [\n {\n \"jurisdiction\": \"BR\",\n \"scheme\": \"cnpj\",\n \"value\": \"12345678000195\"\n }\n ],\n \"notes\": \"Onboarded via referral\",\n \"persons_of_interest\": [\n {\n \"name\": \"Ada Lovelace\",\n \"role\": \"director\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.range.org/v2/parties/{id}/counterparties")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Berlin Bank AG\",\n \"legal_form\": \"business\",\n \"jurisdiction\": \"DE\",\n \"address\": {\n \"line1\": \"Friedrichstraße 1\",\n \"line2\": \"3. OG\",\n \"city\": \"Berlin\",\n \"region\": \"BE\",\n \"postal_code\": \"10117\",\n \"country\": \"DE\"\n },\n \"is_fi\": false,\n \"tax_ids\": [\n {\n \"jurisdiction\": \"BR\",\n \"scheme\": \"cnpj\",\n \"value\": \"12345678000195\"\n }\n ],\n \"notes\": \"Onboarded via referral\",\n \"persons_of_interest\": [\n {\n \"name\": \"Ada Lovelace\",\n \"role\": \"director\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
"name": "Berlin Bank AG",
"types": [
"counterparty"
],
"is_fi": false,
"client_id": null,
"created_at": "2026-09-14T10:00:00.000Z",
"updated_at": "2026-09-14T10:00:00.000Z",
"address": {
"line1": "Friedrichstraße 1",
"line2": "3. OG",
"city": "Berlin",
"region": "BE",
"postal_code": "10117",
"country": "DE"
},
"tax_ids": [
{
"jurisdiction": "BR",
"scheme": "cnpj",
"masked_value": "**********0195"
}
],
"persons_of_interest": [
{
"id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
"name": "Ada Lovelace",
"role": "director"
}
],
"legal_form": "business",
"jurisdiction": "DE",
"notes": "Onboarded via referral"
}Parties
Create a counterparty that belongs to this client
The new entity is a counterparty of this client only. Another client with the same counterparty name gets its own entity. types is not accepted; the row is stored as counterparty.
POST
/
v2
/
parties
/
{id}
/
counterparties
Create a counterparty that belongs to this client
curl --request POST \
--url https://api.range.org/v2/parties/{id}/counterparties \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"name": "Berlin Bank AG",
"legal_form": "business",
"jurisdiction": "DE",
"address": {
"line1": "Friedrichstraße 1",
"line2": "3. OG",
"city": "Berlin",
"region": "BE",
"postal_code": "10117",
"country": "DE"
},
"is_fi": false,
"tax_ids": [
{
"jurisdiction": "BR",
"scheme": "cnpj",
"value": "12345678000195"
}
],
"notes": "Onboarded via referral",
"persons_of_interest": [
{
"name": "Ada Lovelace",
"role": "director"
}
]
}
'import requests
url = "https://api.range.org/v2/parties/{id}/counterparties"
payload = {
"name": "Berlin Bank AG",
"legal_form": "business",
"jurisdiction": "DE",
"address": {
"line1": "Friedrichstraße 1",
"line2": "3. OG",
"city": "Berlin",
"region": "BE",
"postal_code": "10117",
"country": "DE"
},
"is_fi": False,
"tax_ids": [
{
"jurisdiction": "BR",
"scheme": "cnpj",
"value": "12345678000195"
}
],
"notes": "Onboarded via referral",
"persons_of_interest": [
{
"name": "Ada Lovelace",
"role": "director"
}
]
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Berlin Bank AG',
legal_form: 'business',
jurisdiction: 'DE',
address: {
line1: 'Friedrichstraße 1',
line2: '3. OG',
city: 'Berlin',
region: 'BE',
postal_code: '10117',
country: 'DE'
},
is_fi: false,
tax_ids: [{jurisdiction: 'BR', scheme: 'cnpj', value: '12345678000195'}],
notes: 'Onboarded via referral',
persons_of_interest: [{name: 'Ada Lovelace', role: 'director'}]
})
};
fetch('https://api.range.org/v2/parties/{id}/counterparties', 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://api.range.org/v2/parties/{id}/counterparties",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Berlin Bank AG',
'legal_form' => 'business',
'jurisdiction' => 'DE',
'address' => [
'line1' => 'Friedrichstraße 1',
'line2' => '3. OG',
'city' => 'Berlin',
'region' => 'BE',
'postal_code' => '10117',
'country' => 'DE'
],
'is_fi' => false,
'tax_ids' => [
[
'jurisdiction' => 'BR',
'scheme' => 'cnpj',
'value' => '12345678000195'
]
],
'notes' => 'Onboarded via referral',
'persons_of_interest' => [
[
'name' => 'Ada Lovelace',
'role' => 'director'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <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://api.range.org/v2/parties/{id}/counterparties"
payload := strings.NewReader("{\n \"name\": \"Berlin Bank AG\",\n \"legal_form\": \"business\",\n \"jurisdiction\": \"DE\",\n \"address\": {\n \"line1\": \"Friedrichstraße 1\",\n \"line2\": \"3. OG\",\n \"city\": \"Berlin\",\n \"region\": \"BE\",\n \"postal_code\": \"10117\",\n \"country\": \"DE\"\n },\n \"is_fi\": false,\n \"tax_ids\": [\n {\n \"jurisdiction\": \"BR\",\n \"scheme\": \"cnpj\",\n \"value\": \"12345678000195\"\n }\n ],\n \"notes\": \"Onboarded via referral\",\n \"persons_of_interest\": [\n {\n \"name\": \"Ada Lovelace\",\n \"role\": \"director\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<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.post("https://api.range.org/v2/parties/{id}/counterparties")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Berlin Bank AG\",\n \"legal_form\": \"business\",\n \"jurisdiction\": \"DE\",\n \"address\": {\n \"line1\": \"Friedrichstraße 1\",\n \"line2\": \"3. OG\",\n \"city\": \"Berlin\",\n \"region\": \"BE\",\n \"postal_code\": \"10117\",\n \"country\": \"DE\"\n },\n \"is_fi\": false,\n \"tax_ids\": [\n {\n \"jurisdiction\": \"BR\",\n \"scheme\": \"cnpj\",\n \"value\": \"12345678000195\"\n }\n ],\n \"notes\": \"Onboarded via referral\",\n \"persons_of_interest\": [\n {\n \"name\": \"Ada Lovelace\",\n \"role\": \"director\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.range.org/v2/parties/{id}/counterparties")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Berlin Bank AG\",\n \"legal_form\": \"business\",\n \"jurisdiction\": \"DE\",\n \"address\": {\n \"line1\": \"Friedrichstraße 1\",\n \"line2\": \"3. OG\",\n \"city\": \"Berlin\",\n \"region\": \"BE\",\n \"postal_code\": \"10117\",\n \"country\": \"DE\"\n },\n \"is_fi\": false,\n \"tax_ids\": [\n {\n \"jurisdiction\": \"BR\",\n \"scheme\": \"cnpj\",\n \"value\": \"12345678000195\"\n }\n ],\n \"notes\": \"Onboarded via referral\",\n \"persons_of_interest\": [\n {\n \"name\": \"Ada Lovelace\",\n \"role\": \"director\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
"name": "Berlin Bank AG",
"types": [
"counterparty"
],
"is_fi": false,
"client_id": null,
"created_at": "2026-09-14T10:00:00.000Z",
"updated_at": "2026-09-14T10:00:00.000Z",
"address": {
"line1": "Friedrichstraße 1",
"line2": "3. OG",
"city": "Berlin",
"region": "BE",
"postal_code": "10117",
"country": "DE"
},
"tax_ids": [
{
"jurisdiction": "BR",
"scheme": "cnpj",
"masked_value": "**********0195"
}
],
"persons_of_interest": [
{
"id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
"name": "Ada Lovelace",
"role": "director"
}
],
"legal_form": "business",
"jurisdiction": "DE",
"notes": "Onboarded via referral"
}Authorizations
AuthorizationAuthorization
Authorization method required to allow user to access the api endpoints.
Path Parameters
Body
application/json
Example:
"Berlin Bank AG"
Available options:
individual, business Example:
"business"
ISO 3166-1 alpha-2, stored upper-cased.
Example:
"DE"
Show child attributes
Show child attributes
Whether the entity is a regulated financial institution.
Example:
false
Tax identifiers. On PATCH this replaces the whole set — anything absent is deleted.
Maximum array length:
20Show child attributes
Show child attributes
Example:
"Onboarded via referral"
Persons of interest. On PATCH this replaces the whole set — anything absent is deleted.
Maximum array length:
20Show child attributes
Show child attributes
Response
Example:
"a1b2c3d4-5678-90ab-cdef-1234567890ab"
Example:
"Berlin Bank AG"
Available options:
self, client, counterparty Example:
["counterparty"]
Example:
false
The client this counterparty belongs to. Null for workspace-level entities.
Example:
null
Example:
"2026-09-14T10:00:00.000Z"
Example:
"2026-09-14T10:00:00.000Z"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
individual, business Example:
"business"
Example:
"DE"
Example:
"Onboarded via referral"
Last modified on October 7, 2026
Was this page helpful?