Get Account Holder Details

📘

Early Access

Credit API endpoints are currently being finalised as part of ongoing product development. While we do not anticipate significant changes, some interfaces, behaviours, and documentation may be refined before general availability.

The Get Account Holder Details endpoint enables you to retrieve the details Thredd holds for a customer (account holder): their status, name, date of birth, email address, phone numbers and address. Use this endpoint to display a customer's details in your interface, or to check the details Thredd holds against your own records.

📘

More Information

For more information about the Account Holder endpoint, see: Account Holder.

Prerequisites

To integrate calls to the Get Account Holder Details endpoint, you need:

  • The account_holder_id of the customer. This is the Thredd Account Holder ID, returned when a credit application is approved. It is the same ID you use as the customer_id in the Bank Account endpoints.

Example Request

Retrieve an account holder's details by making a GET request to the Get Account Holder Details endpoint.

GET {{baseUrl}}/api/v1/credit/account-holder/{account_holder_id}

Path Parameters

ParameterDescription
account_holder_idstring. Required. The unique identifier (UUID) of the account holder (Thredd Account Holder ID).

Example Response

A successful request returns a 200 HTTP status code with the account holder's details.

{
  "accountHolderId": "3f2b1c4d-0000-4a5b-8c7d-9e0f1a2b3c4d",
  "status": "ACTIVE",
  "email": "[email protected]",
  "firstName": "Jane",
  "middleName": null,
  "lastName": "Smith",
  "dateOfBirth": "1985-04-12",
  "phoneNumbers": {
    "mobile": "+12025550143",
    "work": null,
    "home": null
  },
  "address": {
    "addressLine1": "1000 Market Street",
    "addressLine2": "Suite 101",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94105",
    "country": "US"
  }
}
{
  "detail": [
    {
      "loc": ["path", "account_holder_id"],
      "msg": "Field required",
      "type": "missing"
    }
  ]
}

Response Fields

Account Holder Object

AttributeDescription
accountHolderIdstring. The unique identifier (UUID) of the account holder (Thredd Account Holder ID).
statusstring. The status of the account holder.
emailstring or null. The account holder's email address.
firstNamestring. The account holder's first name.
middleNamestring or null. The account holder's middle name.
lastNamestring. The account holder's last name.
dateOfBirthstring or null. The account holder's date of birth, in YYYY-MM-DD format.
phoneNumbersobject. The account holder's phone numbers. See Phone Numbers Object.
addressobject or null. The account holder's address. See Address Object.

Phone Numbers Object

AttributeDescription
mobilestring or null. The mobile phone number.
workstring or null. The work phone number.
homestring or null. The home phone number.

Address Object

AttributeDescription
addressLine1string. The first line of the address.
addressLine2string or null. The second line of the address.
citystring. The city.
statestring or null. The state.
postalCodestring. The postal code or ZIP code.
countrystring. The country.

Error Messages

If there is a problem with the request, the response returns the following error:

  • 422: The account_holder_id is missing or not valid. The response includes details of the validation failure.

Did this page help you?