Skip to main content
GET
/
v1
/
persons
List all IVMS101 person records
curl --request GET \
  --url https://api.faraday.range.org/v1/persons \
  --header 'Authorization: Bearer <token>'
[
  {
    "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.

Response

OK

Persons records were successfully retrieved.

​
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).

  • Option 1
  • Option 2