Overview
Architecture
Integration Guide
Product Information
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"
}
}
}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.
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
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
The complete replacement payload for the IVMS101 person. Must include all required fields.
- Option 1
- Option 2
Create a natural person
natural Physical or mailing addresses
Show child attributes
Show child attributes
Free format address lines. See IVMS101 Section 5.2.6.3.15 and constraint C8.
1 - 140"[\"Company HQ\", \"Main Street\"]"
Identifies the nature of the address (geographic/home/business). See IVMS101 Section 5.2.6.3.1.
GEOG, HOME, BIZZ "GEOG"
Name of the building or house. See IVMS101 Section 5.2.6.3.6.
1 - 35"Holmes Residence"
Number that identifies the position of a building on a street. See IVMS101 Section 5.2.6.3.5.
1 - 16"221B"
ISO 3166-1 alpha-2 country code. See IVMS101 constraint C3 and Section 5.2.6.3.16.
"GB"
Identifies a subdivision of a country (state/region/province). See IVMS101 Section 5.2.6.3.14.
1 - 35"England"
Identification of a division of a large organisation or building. See IVMS101 Section 5.2.6.3.2.
1 - 35"Compliance Department"
Subdivision within a country subdivision. See IVMS101 Section 5.2.6.3.13.
1 - 35"Greater London"
Floor or storey within a building. See IVMS101 Section 5.2.6.3.7.
1 - 70"2nd Floor"
Numbered box in a post office. See IVMS101 Section 5.2.6.3.8.
1 - 16"PO123"
Postal code. See IVMS101 Section 5.2.6.3.10.
1 - 16"NW1 6XE"
Building room number. See IVMS101 Section 5.2.6.3.9.
1 - 35"Room 221"
Name of a street or thoroughfare. See IVMS101 Section 5.2.6.3.4.
1 - 70"Main Street"
Identification of a sub-division. See IVMS101 Section 5.2.6.3.3.
1 - 35"Risk Team"
Specific location name within the town. See IVMS101 Section 5.2.6.3.12.
1 - 35"Westminster"
Name of built-up area. See IVMS101 Section 5.2.6.3.11.
1 - 35"London"
Official or alias names associated with this person
Show child attributes
Show child attributes
Indicates if this is the legal name. See IVMS101 constraints C6/C5.
true
The nature of the name specified (legal, alias, birth, etc.). See IVMS101 Section 5.2.4.3.3.
LEGL, ALIA, BIRT, MAID, MISC "LEGL"
Primary identifier (surname or full name). See IVMS101 Section 5.2.4.3.1.
1 - 100"Sherlock Holmes"
Secondary identifier (forenames, initials). See IVMS101 Section 5.2.4.3.2.
100"S. Holmes"
National identifiers (e.g., passport, national ID)
Show child attributes
Show child attributes
ISO 3166-1 alpha-2 country code of the issuing authority. See IVMS101 constraint C3.
"GB"
Specifies the type of the national identifier. See IVMS101 Section 5.2.8.3.2.
1 - 35"LEIX"
An identifier issued by an appropriate issuing authority. See IVMS101 Section 5.2.8.3.1.
1 - 35"GB123456789"
Registration authority code; 8-character. See IVMS101 Sections C9/C10.
8"RA000001"
Core details about the natural person
Show child attributes
Show child attributes
ISO 3166-1 alpha-2 country code of residence. See IVMS101 constraint C3 and Section 5.2.2.3.6. ISO 3166-1 alpha-2 country code
"GB"
A distinct identifier that uniquely identifies the person to the institution in context. See IVMS101 Section 5.2.2.3.4.
50"HOLMES001"
Date of birth; must be a historic date per constraint C2. See IVMS101 Section 5.2.7.
"1854-01-06"
Place of birth (town/city/subdivision/country). See IVMS101 Section 5.2.7.3.2.
1 - 100"Baker Street, London"
Response
OK
The person record was successfully updated.
Registered or physical addresses.
Show child attributes
Show child attributes
Free format address lines. See IVMS101 Section 5.2.6.3.15 and constraint C8.
1 - 140"[\"Company HQ\", \"Main Street\"]"
Identifies the nature of the address (geographic/home/business). See IVMS101 Section 5.2.6.3.1.
GEOG, HOME, BIZZ "GEOG"
Name of the building or house. See IVMS101 Section 5.2.6.3.6.
1 - 35"Holmes Residence"
Number that identifies the position of a building on a street. See IVMS101 Section 5.2.6.3.5.
1 - 16"221B"
ISO 3166-1 alpha-2 country code. See IVMS101 constraint C3 and Section 5.2.6.3.16.
"GB"
Identifies a subdivision of a country (state/region/province). See IVMS101 Section 5.2.6.3.14.
1 - 35"England"
Identification of a division of a large organisation or building. See IVMS101 Section 5.2.6.3.2.
1 - 35"Compliance Department"
Subdivision within a country subdivision. See IVMS101 Section 5.2.6.3.13.
1 - 35"Greater London"
Floor or storey within a building. See IVMS101 Section 5.2.6.3.7.
1 - 70"2nd Floor"
Numbered box in a post office. See IVMS101 Section 5.2.6.3.8.
1 - 16"PO123"
Postal code. See IVMS101 Section 5.2.6.3.10.
1 - 16"NW1 6XE"
Building room number. See IVMS101 Section 5.2.6.3.9.
1 - 35"Room 221"
Name of a street or thoroughfare. See IVMS101 Section 5.2.6.3.4.
1 - 70"Main Street"
Identification of a sub-division. See IVMS101 Section 5.2.6.3.3.
1 - 35"Risk Team"
Specific location name within the town. See IVMS101 Section 5.2.6.3.12.
1 - 35"Westminster"
Name of built-up area. See IVMS101 Section 5.2.6.3.11.
1 - 35"London"
[
{
"address_type": "GEOG",
"country": "GB",
"town_name": "London"
}
]Timestamp when the person was created (UTC).
"2025-07-29T14:45:00"
Unique identifier of the person record.
"d2fd3b17-1fcd-4c4f-bc0e-3b6f858a5e5d"
List of name identifiers (e.g., legal name, aliases).
Show child attributes
Show child attributes
Indicates if this is the legal name. See IVMS101 constraints C6/C5.
true
The nature of the name specified (legal, alias, birth, etc.). See IVMS101 Section 5.2.4.3.3.
LEGL, ALIA, BIRT, MAID, MISC "LEGL"
Primary identifier (surname or full name). See IVMS101 Section 5.2.4.3.1.
1 - 100"Sherlock Holmes"
Secondary identifier (forenames, initials). See IVMS101 Section 5.2.4.3.2.
100"S. Holmes"
[
{
"is_legal": true,
"kind": "LEGL",
"primary_identifier": "Acme Corp"
}
]National identifiers (e.g., passport, tax ID).
Show child attributes
Show child attributes
ISO 3166-1 alpha-2 country code of the issuing authority. See IVMS101 constraint C3.
"GB"
Specifies the type of the national identifier. See IVMS101 Section 5.2.8.3.2.
1 - 35"LEIX"
An identifier issued by an appropriate issuing authority. See IVMS101 Section 5.2.8.3.1.
1 - 35"GB123456789"
Registration authority code; 8-character. See IVMS101 Sections C9/C10.
8"RA000001"
[
{
"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
natural Represents a uniquely distinguishable individual; one single person with KYC-related attributes. See IVMS101 Section 5.2.2.3.
Show child attributes
Show child attributes
ISO 3166-1 alpha-2 country code of residence. See IVMS101 constraint C3 and Section 5.2.2.3.6. ISO 3166-1 alpha-2 country code
"GB"
A distinct identifier that uniquely identifies the person to the institution in context. See IVMS101 Section 5.2.2.3.4.
50"HOLMES001"
Date of birth; must be a historic date per constraint C2. See IVMS101 Section 5.2.7.
"1854-01-06"
Place of birth (town/city/subdivision/country). See IVMS101 Section 5.2.7.3.2.
1 - 100"Baker Street, London"