Account Holder Object

The Account Holder object represents the owner of an account, containing their personal information and ownership details.

Properties

id
string
required

Unique identifier for the account holder

name
string
required

The full name of the account holder

email
string

The email address of the account holder

phone
string

The phone number of the account holder

address
object
accounts
array

List of account IDs associated with this account holder

refreshedAt
timestamp

The timestamp when the account holder’s information was last refreshed

Endpoints

Retrieve Account Holder

Retrieves a single account holder by their ID.

POST /api/services/data/account-holders/retrieve

Request

accountId
string
required

The ID of the account to retrieve the account holder for

Response
{
  "id": "ah_12345",
  "name": "Jane Smith",
  "email": "jane.smith@example.com",
  "phone": "+44123456789",
  "address": {
    "streetAddress": "123 Main Street",
    "city": "London",
    "postalCode": "E1 6AN",
    "country": "GB"
  },
  "accounts": ["acc_12345", "acc_12346"],
  "refreshedAt": "2024-01-27T10:00:00Z"
}