Skip to main content
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"
  }
}
'
{
  "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

​
Authorization
string
header
required

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

Path Parameters

​
id
string<uuid>
required

Unique identifier of the person to update (UUID)

Body

application/json

The complete replacement payload for the IVMS101 person. Must include all required fields.

Create a natural person

​
kind
enum<string>
required
Available options:
natural
​
account_numbers
object[]

List of bank or wallet account numbers

​
addresses
object[]

Physical or mailing addresses

​
name_identifiers
object[]

Official or alias names associated with this person

​
national_identifiers
object[]

National identifiers (e.g., passport, national ID)

​
person
object

Core details about the natural person

Response

OK

The person record was successfully updated.

​
account_numbers
object[]
required

Account numbers (bank or wallet identifiers).

Example:
[
  {
    "account_number": "GB29NWBK60161331926819"
  }
]
​
addresses
object[]
required

Registered or physical addresses.

Example:
[
  {
    "address_type": "GEOG",
    "country": "GB",
    "town_name": "London"
  }
]
​
created_at
string<date-time>
required

Timestamp when the person was created (UTC).

Example:

"2025-07-29T14:45:00"

​
id
string<uuid>
required

Unique identifier of the person record.

Example:

"d2fd3b17-1fcd-4c4f-bc0e-3b6f858a5e5d"

​
name_identifiers
object[]
required

List of name identifiers (e.g., legal name, aliases).

Example:
[
  {
    "is_legal": true,
    "kind": "LEGL",
    "primary_identifier": "Acme Corp"
  }
]
​
national_identifiers
object[]
required

National identifiers (e.g., passport, tax ID).

Example:
[
  {
    "country_of_issue": "GB",
    "identifier_type": "tax_id",
    "national_identifier": "123456789"
  }
]
​
person
object
required

The core person object (either natural or legal).