Update 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 Update Account Holder Details endpoint enables you to update the email address, phone numbers and address Thredd holds for a customer account holder. Send only the details you want to change. Thredd returns the account holder's full details after the update.

You cannot change the account holder's status, name or date of birth with this endpoint.

📘

More Information

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

Prerequisites

To integrate calls to the Update 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

Update an account holder's details by making a PATCH request to the Update Account Holder Details endpoint.

PATCH {{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).

Request Body

The following example updates the account holder's email address, mobile phone number and address.

{
  "email": "[email protected]",
  "phoneNumbers": {
    "mobile": "+12025550143"
  },
  "address": {
    "addressLine1": "1000 Market Street",
    "addressLine2": "Suite 101",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94105",
    "country": "US"
  }
}

Request Body Fields

All fields are optional. Include only the fields you want to update.

AttributeDescription
emailstring or null. The account holder's email address.
phoneNumbersobject or null. 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 or null. The first line of the address.
addressLine2string or null. The second line of the address.
citystring or null. The city.
statestring or null. The state.
postalCodestring or null. The postal code or ZIP code.
countrystring or null. The country.

Example Response

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

{
  "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": ["body", "email"],
      "msg": "Input should be a valid string",
      "type": "string_type"
    }
  ]
}

Response Fields

The response returns the full account holder object, in the same format as Get Account Holder Details.

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.

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, or a field in the request body is not valid. The response includes details of the validation failure.

Did this page help you?