Update a person
curl --request PUT \
--url https://api.faraday.range.org/v1/persons/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"kind": "natural",
"account_numbers": [
{
"account_number": "HOLMESACC12345"
}
],
"addresses": [
{
"address_lines": "[\"Company HQ\", \"Main Street\"]",
"address_type": "GEOG",
"building_name": "Holmes Residence",
"building_number": "221B",
"country": "GB",
"country_sub_division": "England",
"department": "Compliance Department",
"district_name": "Greater London",
"floor": "2nd Floor",
"post_box": "PO123",
"postcode": "NW1 6XE",
"room": "Room 221",
"street_name": "Main Street",
"sub_department": "Risk Team",
"town_location_name": "Westminster",
"town_name": "London"
}
],
"name_identifiers": [
{
"is_legal": true,
"kind": "LEGL",
"primary_identifier": "Sherlock Holmes",
"secondary_identifier": "S. Holmes"
}
],
"national_identifiers": [
{
"country_of_issue": "GB",
"identifier_type": "LEIX",
"national_identifier": "GB123456789",
"registration_authority": "RA000001"
}
],
"person": {
"country_of_residence": "GB",
"customer_identification": "HOLMES001",
"date_of_birth": "1854-01-06",
"place_of_birth": "Baker Street, London"
}
}
'import requests
url = "https://api.faraday.range.org/v1/persons/{id}"
payload = {
"kind": "natural",
"account_numbers": [{ "account_number": "HOLMESACC12345" }],
"addresses": [
{
"address_lines": "[\"Company HQ\", \"Main Street\"]",
"address_type": "GEOG",
"building_name": "Holmes Residence",
"building_number": "221B",
"country": "GB",
"country_sub_division": "England",
"department": "Compliance Department",
"district_name": "Greater London",
"floor": "2nd Floor",
"post_box": "PO123",
"postcode": "NW1 6XE",
"room": "Room 221",
"street_name": "Main Street",
"sub_department": "Risk Team",
"town_location_name": "Westminster",
"town_name": "London"
}
],
"name_identifiers": [
{
"is_legal": True,
"kind": "LEGL",
"primary_identifier": "Sherlock Holmes",
"secondary_identifier": "S. Holmes"
}
],
"national_identifiers": [
{
"country_of_issue": "GB",
"identifier_type": "LEIX",
"national_identifier": "GB123456789",
"registration_authority": "RA000001"
}
],
"person": {
"country_of_residence": "GB",
"customer_identification": "HOLMES001",
"date_of_birth": "1854-01-06",
"place_of_birth": "Baker Street, London"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
kind: 'natural',
account_numbers: [{account_number: 'HOLMESACC12345'}],
addresses: [
{
address_lines: '["Company HQ", "Main Street"]',
address_type: 'GEOG',
building_name: 'Holmes Residence',
building_number: '221B',
country: 'GB',
country_sub_division: 'England',
department: 'Compliance Department',
district_name: 'Greater London',
floor: '2nd Floor',
post_box: 'PO123',
postcode: 'NW1 6XE',
room: 'Room 221',
street_name: 'Main Street',
sub_department: 'Risk Team',
town_location_name: 'Westminster',
town_name: 'London'
}
],
name_identifiers: [
{
is_legal: true,
kind: 'LEGL',
primary_identifier: 'Sherlock Holmes',
secondary_identifier: 'S. Holmes'
}
],
national_identifiers: [
{
country_of_issue: 'GB',
identifier_type: 'LEIX',
national_identifier: 'GB123456789',
registration_authority: 'RA000001'
}
],
person: {
country_of_residence: 'GB',
customer_identification: 'HOLMES001',
date_of_birth: '1854-01-06',
place_of_birth: 'Baker Street, London'
}
})
};
fetch('https://api.faraday.range.org/v1/persons/{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://api.faraday.range.org/v1/persons/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'kind' => 'natural',
'account_numbers' => [
[
'account_number' => 'HOLMESACC12345'
]
],
'addresses' => [
[
'address_lines' => '["Company HQ", "Main Street"]',
'address_type' => 'GEOG',
'building_name' => 'Holmes Residence',
'building_number' => '221B',
'country' => 'GB',
'country_sub_division' => 'England',
'department' => 'Compliance Department',
'district_name' => 'Greater London',
'floor' => '2nd Floor',
'post_box' => 'PO123',
'postcode' => 'NW1 6XE',
'room' => 'Room 221',
'street_name' => 'Main Street',
'sub_department' => 'Risk Team',
'town_location_name' => 'Westminster',
'town_name' => 'London'
]
],
'name_identifiers' => [
[
'is_legal' => true,
'kind' => 'LEGL',
'primary_identifier' => 'Sherlock Holmes',
'secondary_identifier' => 'S. Holmes'
]
],
'national_identifiers' => [
[
'country_of_issue' => 'GB',
'identifier_type' => 'LEIX',
'national_identifier' => 'GB123456789',
'registration_authority' => 'RA000001'
]
],
'person' => [
'country_of_residence' => 'GB',
'customer_identification' => 'HOLMES001',
'date_of_birth' => '1854-01-06',
'place_of_birth' => 'Baker Street, London'
]
]),
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://api.faraday.range.org/v1/persons/{id}"
payload := strings.NewReader("{\n \"kind\": \"natural\",\n \"account_numbers\": [\n {\n \"account_number\": \"HOLMESACC12345\"\n }\n ],\n \"addresses\": [\n {\n \"address_lines\": \"[\\\"Company HQ\\\", \\\"Main Street\\\"]\",\n \"address_type\": \"GEOG\",\n \"building_name\": \"Holmes Residence\",\n \"building_number\": \"221B\",\n \"country\": \"GB\",\n \"country_sub_division\": \"England\",\n \"department\": \"Compliance Department\",\n \"district_name\": \"Greater London\",\n \"floor\": \"2nd Floor\",\n \"post_box\": \"PO123\",\n \"postcode\": \"NW1 6XE\",\n \"room\": \"Room 221\",\n \"street_name\": \"Main Street\",\n \"sub_department\": \"Risk Team\",\n \"town_location_name\": \"Westminster\",\n \"town_name\": \"London\"\n }\n ],\n \"name_identifiers\": [\n {\n \"is_legal\": true,\n \"kind\": \"LEGL\",\n \"primary_identifier\": \"Sherlock Holmes\",\n \"secondary_identifier\": \"S. Holmes\"\n }\n ],\n \"national_identifiers\": [\n {\n \"country_of_issue\": \"GB\",\n \"identifier_type\": \"LEIX\",\n \"national_identifier\": \"GB123456789\",\n \"registration_authority\": \"RA000001\"\n }\n ],\n \"person\": {\n \"country_of_residence\": \"GB\",\n \"customer_identification\": \"HOLMES001\",\n \"date_of_birth\": \"1854-01-06\",\n \"place_of_birth\": \"Baker Street, London\"\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.faraday.range.org/v1/persons/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"kind\": \"natural\",\n \"account_numbers\": [\n {\n \"account_number\": \"HOLMESACC12345\"\n }\n ],\n \"addresses\": [\n {\n \"address_lines\": \"[\\\"Company HQ\\\", \\\"Main Street\\\"]\",\n \"address_type\": \"GEOG\",\n \"building_name\": \"Holmes Residence\",\n \"building_number\": \"221B\",\n \"country\": \"GB\",\n \"country_sub_division\": \"England\",\n \"department\": \"Compliance Department\",\n \"district_name\": \"Greater London\",\n \"floor\": \"2nd Floor\",\n \"post_box\": \"PO123\",\n \"postcode\": \"NW1 6XE\",\n \"room\": \"Room 221\",\n \"street_name\": \"Main Street\",\n \"sub_department\": \"Risk Team\",\n \"town_location_name\": \"Westminster\",\n \"town_name\": \"London\"\n }\n ],\n \"name_identifiers\": [\n {\n \"is_legal\": true,\n \"kind\": \"LEGL\",\n \"primary_identifier\": \"Sherlock Holmes\",\n \"secondary_identifier\": \"S. Holmes\"\n }\n ],\n \"national_identifiers\": [\n {\n \"country_of_issue\": \"GB\",\n \"identifier_type\": \"LEIX\",\n \"national_identifier\": \"GB123456789\",\n \"registration_authority\": \"RA000001\"\n }\n ],\n \"person\": {\n \"country_of_residence\": \"GB\",\n \"customer_identification\": \"HOLMES001\",\n \"date_of_birth\": \"1854-01-06\",\n \"place_of_birth\": \"Baker Street, London\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.faraday.range.org/v1/persons/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"kind\": \"natural\",\n \"account_numbers\": [\n {\n \"account_number\": \"HOLMESACC12345\"\n }\n ],\n \"addresses\": [\n {\n \"address_lines\": \"[\\\"Company HQ\\\", \\\"Main Street\\\"]\",\n \"address_type\": \"GEOG\",\n \"building_name\": \"Holmes Residence\",\n \"building_number\": \"221B\",\n \"country\": \"GB\",\n \"country_sub_division\": \"England\",\n \"department\": \"Compliance Department\",\n \"district_name\": \"Greater London\",\n \"floor\": \"2nd Floor\",\n \"post_box\": \"PO123\",\n \"postcode\": \"NW1 6XE\",\n \"room\": \"Room 221\",\n \"street_name\": \"Main Street\",\n \"sub_department\": \"Risk Team\",\n \"town_location_name\": \"Westminster\",\n \"town_name\": \"London\"\n }\n ],\n \"name_identifiers\": [\n {\n \"is_legal\": true,\n \"kind\": \"LEGL\",\n \"primary_identifier\": \"Sherlock Holmes\",\n \"secondary_identifier\": \"S. Holmes\"\n }\n ],\n \"national_identifiers\": [\n {\n \"country_of_issue\": \"GB\",\n \"identifier_type\": \"LEIX\",\n \"national_identifier\": \"GB123456789\",\n \"registration_authority\": \"RA000001\"\n }\n ],\n \"person\": {\n \"country_of_residence\": \"GB\",\n \"customer_identification\": \"HOLMES001\",\n \"date_of_birth\": \"1854-01-06\",\n \"place_of_birth\": \"Baker Street, London\"\n }\n}"
response = http.request(request)
puts response.read_body{
"account_numbers": [
{
"account_number": "GB29NWBK60161331926819"
}
],
"addresses": [
{
"address_type": "GEOG",
"country": "GB",
"town_name": "London"
}
],
"created_at": "2025-07-29T14:45:00",
"id": "d2fd3b17-1fcd-4c4f-bc0e-3b6f858a5e5d",
"name_identifiers": [
{
"is_legal": true,
"kind": "LEGL",
"primary_identifier": "Acme Corp"
}
],
"national_identifiers": [
{
"country_of_issue": "GB",
"identifier_type": "tax_id",
"national_identifier": "123456789"
}
],
"person": {
"kind": "natural",
"person": {
"country_of_residence": "GB",
"customer_identification": "HOLMES001",
"date_of_birth": "1854-01-06",
"place_of_birth": "Baker Street, London"
}
}
}Persons
Update a person
Fully replaces an IVMS101-compliant person entity by ID. The provided payload must be complete and include all fields for either a natural or legal person.
PUT
/
v1
/
persons
/
{id}
Update a person
curl --request PUT \
--url https://api.faraday.range.org/v1/persons/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"kind": "natural",
"account_numbers": [
{
"account_number": "HOLMESACC12345"
}
],
"addresses": [
{
"address_lines": "[\"Company HQ\", \"Main Street\"]",
"address_type": "GEOG",
"building_name": "Holmes Residence",
"building_number": "221B",
"country": "GB",
"country_sub_division": "England",
"department": "Compliance Department",
"district_name": "Greater London",
"floor": "2nd Floor",
"post_box": "PO123",
"postcode": "NW1 6XE",
"room": "Room 221",
"street_name": "Main Street",
"sub_department": "Risk Team",
"town_location_name": "Westminster",
"town_name": "London"
}
],
"name_identifiers": [
{
"is_legal": true,
"kind": "LEGL",
"primary_identifier": "Sherlock Holmes",
"secondary_identifier": "S. Holmes"
}
],
"national_identifiers": [
{
"country_of_issue": "GB",
"identifier_type": "LEIX",
"national_identifier": "GB123456789",
"registration_authority": "RA000001"
}
],
"person": {
"country_of_residence": "GB",
"customer_identification": "HOLMES001",
"date_of_birth": "1854-01-06",
"place_of_birth": "Baker Street, London"
}
}
'import requests
url = "https://api.faraday.range.org/v1/persons/{id}"
payload = {
"kind": "natural",
"account_numbers": [{ "account_number": "HOLMESACC12345" }],
"addresses": [
{
"address_lines": "[\"Company HQ\", \"Main Street\"]",
"address_type": "GEOG",
"building_name": "Holmes Residence",
"building_number": "221B",
"country": "GB",
"country_sub_division": "England",
"department": "Compliance Department",
"district_name": "Greater London",
"floor": "2nd Floor",
"post_box": "PO123",
"postcode": "NW1 6XE",
"room": "Room 221",
"street_name": "Main Street",
"sub_department": "Risk Team",
"town_location_name": "Westminster",
"town_name": "London"
}
],
"name_identifiers": [
{
"is_legal": True,
"kind": "LEGL",
"primary_identifier": "Sherlock Holmes",
"secondary_identifier": "S. Holmes"
}
],
"national_identifiers": [
{
"country_of_issue": "GB",
"identifier_type": "LEIX",
"national_identifier": "GB123456789",
"registration_authority": "RA000001"
}
],
"person": {
"country_of_residence": "GB",
"customer_identification": "HOLMES001",
"date_of_birth": "1854-01-06",
"place_of_birth": "Baker Street, London"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
kind: 'natural',
account_numbers: [{account_number: 'HOLMESACC12345'}],
addresses: [
{
address_lines: '["Company HQ", "Main Street"]',
address_type: 'GEOG',
building_name: 'Holmes Residence',
building_number: '221B',
country: 'GB',
country_sub_division: 'England',
department: 'Compliance Department',
district_name: 'Greater London',
floor: '2nd Floor',
post_box: 'PO123',
postcode: 'NW1 6XE',
room: 'Room 221',
street_name: 'Main Street',
sub_department: 'Risk Team',
town_location_name: 'Westminster',
town_name: 'London'
}
],
name_identifiers: [
{
is_legal: true,
kind: 'LEGL',
primary_identifier: 'Sherlock Holmes',
secondary_identifier: 'S. Holmes'
}
],
national_identifiers: [
{
country_of_issue: 'GB',
identifier_type: 'LEIX',
national_identifier: 'GB123456789',
registration_authority: 'RA000001'
}
],
person: {
country_of_residence: 'GB',
customer_identification: 'HOLMES001',
date_of_birth: '1854-01-06',
place_of_birth: 'Baker Street, London'
}
})
};
fetch('https://api.faraday.range.org/v1/persons/{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://api.faraday.range.org/v1/persons/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'kind' => 'natural',
'account_numbers' => [
[
'account_number' => 'HOLMESACC12345'
]
],
'addresses' => [
[
'address_lines' => '["Company HQ", "Main Street"]',
'address_type' => 'GEOG',
'building_name' => 'Holmes Residence',
'building_number' => '221B',
'country' => 'GB',
'country_sub_division' => 'England',
'department' => 'Compliance Department',
'district_name' => 'Greater London',
'floor' => '2nd Floor',
'post_box' => 'PO123',
'postcode' => 'NW1 6XE',
'room' => 'Room 221',
'street_name' => 'Main Street',
'sub_department' => 'Risk Team',
'town_location_name' => 'Westminster',
'town_name' => 'London'
]
],
'name_identifiers' => [
[
'is_legal' => true,
'kind' => 'LEGL',
'primary_identifier' => 'Sherlock Holmes',
'secondary_identifier' => 'S. Holmes'
]
],
'national_identifiers' => [
[
'country_of_issue' => 'GB',
'identifier_type' => 'LEIX',
'national_identifier' => 'GB123456789',
'registration_authority' => 'RA000001'
]
],
'person' => [
'country_of_residence' => 'GB',
'customer_identification' => 'HOLMES001',
'date_of_birth' => '1854-01-06',
'place_of_birth' => 'Baker Street, London'
]
]),
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://api.faraday.range.org/v1/persons/{id}"
payload := strings.NewReader("{\n \"kind\": \"natural\",\n \"account_numbers\": [\n {\n \"account_number\": \"HOLMESACC12345\"\n }\n ],\n \"addresses\": [\n {\n \"address_lines\": \"[\\\"Company HQ\\\", \\\"Main Street\\\"]\",\n \"address_type\": \"GEOG\",\n \"building_name\": \"Holmes Residence\",\n \"building_number\": \"221B\",\n \"country\": \"GB\",\n \"country_sub_division\": \"England\",\n \"department\": \"Compliance Department\",\n \"district_name\": \"Greater London\",\n \"floor\": \"2nd Floor\",\n \"post_box\": \"PO123\",\n \"postcode\": \"NW1 6XE\",\n \"room\": \"Room 221\",\n \"street_name\": \"Main Street\",\n \"sub_department\": \"Risk Team\",\n \"town_location_name\": \"Westminster\",\n \"town_name\": \"London\"\n }\n ],\n \"name_identifiers\": [\n {\n \"is_legal\": true,\n \"kind\": \"LEGL\",\n \"primary_identifier\": \"Sherlock Holmes\",\n \"secondary_identifier\": \"S. Holmes\"\n }\n ],\n \"national_identifiers\": [\n {\n \"country_of_issue\": \"GB\",\n \"identifier_type\": \"LEIX\",\n \"national_identifier\": \"GB123456789\",\n \"registration_authority\": \"RA000001\"\n }\n ],\n \"person\": {\n \"country_of_residence\": \"GB\",\n \"customer_identification\": \"HOLMES001\",\n \"date_of_birth\": \"1854-01-06\",\n \"place_of_birth\": \"Baker Street, London\"\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.faraday.range.org/v1/persons/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"kind\": \"natural\",\n \"account_numbers\": [\n {\n \"account_number\": \"HOLMESACC12345\"\n }\n ],\n \"addresses\": [\n {\n \"address_lines\": \"[\\\"Company HQ\\\", \\\"Main Street\\\"]\",\n \"address_type\": \"GEOG\",\n \"building_name\": \"Holmes Residence\",\n \"building_number\": \"221B\",\n \"country\": \"GB\",\n \"country_sub_division\": \"England\",\n \"department\": \"Compliance Department\",\n \"district_name\": \"Greater London\",\n \"floor\": \"2nd Floor\",\n \"post_box\": \"PO123\",\n \"postcode\": \"NW1 6XE\",\n \"room\": \"Room 221\",\n \"street_name\": \"Main Street\",\n \"sub_department\": \"Risk Team\",\n \"town_location_name\": \"Westminster\",\n \"town_name\": \"London\"\n }\n ],\n \"name_identifiers\": [\n {\n \"is_legal\": true,\n \"kind\": \"LEGL\",\n \"primary_identifier\": \"Sherlock Holmes\",\n \"secondary_identifier\": \"S. Holmes\"\n }\n ],\n \"national_identifiers\": [\n {\n \"country_of_issue\": \"GB\",\n \"identifier_type\": \"LEIX\",\n \"national_identifier\": \"GB123456789\",\n \"registration_authority\": \"RA000001\"\n }\n ],\n \"person\": {\n \"country_of_residence\": \"GB\",\n \"customer_identification\": \"HOLMES001\",\n \"date_of_birth\": \"1854-01-06\",\n \"place_of_birth\": \"Baker Street, London\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.faraday.range.org/v1/persons/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"kind\": \"natural\",\n \"account_numbers\": [\n {\n \"account_number\": \"HOLMESACC12345\"\n }\n ],\n \"addresses\": [\n {\n \"address_lines\": \"[\\\"Company HQ\\\", \\\"Main Street\\\"]\",\n \"address_type\": \"GEOG\",\n \"building_name\": \"Holmes Residence\",\n \"building_number\": \"221B\",\n \"country\": \"GB\",\n \"country_sub_division\": \"England\",\n \"department\": \"Compliance Department\",\n \"district_name\": \"Greater London\",\n \"floor\": \"2nd Floor\",\n \"post_box\": \"PO123\",\n \"postcode\": \"NW1 6XE\",\n \"room\": \"Room 221\",\n \"street_name\": \"Main Street\",\n \"sub_department\": \"Risk Team\",\n \"town_location_name\": \"Westminster\",\n \"town_name\": \"London\"\n }\n ],\n \"name_identifiers\": [\n {\n \"is_legal\": true,\n \"kind\": \"LEGL\",\n \"primary_identifier\": \"Sherlock Holmes\",\n \"secondary_identifier\": \"S. Holmes\"\n }\n ],\n \"national_identifiers\": [\n {\n \"country_of_issue\": \"GB\",\n \"identifier_type\": \"LEIX\",\n \"national_identifier\": \"GB123456789\",\n \"registration_authority\": \"RA000001\"\n }\n ],\n \"person\": {\n \"country_of_residence\": \"GB\",\n \"customer_identification\": \"HOLMES001\",\n \"date_of_birth\": \"1854-01-06\",\n \"place_of_birth\": \"Baker Street, London\"\n }\n}"
response = http.request(request)
puts response.read_body{
"account_numbers": [
{
"account_number": "GB29NWBK60161331926819"
}
],
"addresses": [
{
"address_type": "GEOG",
"country": "GB",
"town_name": "London"
}
],
"created_at": "2025-07-29T14:45:00",
"id": "d2fd3b17-1fcd-4c4f-bc0e-3b6f858a5e5d",
"name_identifiers": [
{
"is_legal": true,
"kind": "LEGL",
"primary_identifier": "Acme Corp"
}
],
"national_identifiers": [
{
"country_of_issue": "GB",
"identifier_type": "tax_id",
"national_identifier": "123456789"
}
],
"person": {
"kind": "natural",
"person": {
"country_of_residence": "GB",
"customer_identification": "HOLMES001",
"date_of_birth": "1854-01-06",
"place_of_birth": "Baker Street, London"
}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Unique identifier of the person to update (UUID)
Body
application/json
The complete replacement payload for the IVMS101 person. Must include all required fields.
- Option 1
- Option 2
Create a natural person
Available options:
natural List of bank or wallet account numbers
Show child attributes
Show child attributes
Physical or mailing addresses
Show child attributes
Show child attributes
Official or alias names associated with this person
Show child attributes
Show child attributes
National identifiers (e.g., passport, national ID)
Show child attributes
Show child attributes
Core details about the natural person
Show child attributes
Show child attributes
Response
OK
The person record was successfully updated.
Account numbers (bank or wallet identifiers).
Show child attributes
Show child attributes
Example:
[
{
"account_number": "GB29NWBK60161331926819"
}
]
Registered or physical addresses.
Show child attributes
Show child attributes
Example:
[
{
"address_type": "GEOG",
"country": "GB",
"town_name": "London"
}
]
Timestamp when the person was created (UTC).
Example:
"2025-07-29T14:45:00"
Unique identifier of the person record.
Example:
"d2fd3b17-1fcd-4c4f-bc0e-3b6f858a5e5d"
List of name identifiers (e.g., legal name, aliases).
Show child attributes
Show child attributes
Example:
[
{
"is_legal": true,
"kind": "LEGL",
"primary_identifier": "Acme Corp"
}
]
National identifiers (e.g., passport, tax ID).
Show child attributes
Show child attributes
Example:
[
{
"country_of_issue": "GB",
"identifier_type": "tax_id",
"national_identifier": "123456789"
}
]
The core person object (either natural or legal).
- Option 1
- Option 2
Show child attributes
Show child attributes
Last modified on June 23, 2026
Was this page helpful?
⌘I