Get Account Holder Details
Early AccessCredit 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 InformationFor 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_idof the customer. This is the Thredd Account Holder ID, returned when a credit application is approved. It is the same ID you use as thecustomer_idin 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
| Parameter | Description |
|---|---|
account_holder_id | string. 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
| Attribute | Description |
|---|---|
accountHolderId | string. The unique identifier (UUID) of the account holder (Thredd Account Holder ID). |
status | string. The status of the account holder. |
email | string or null. The account holder's email address. |
firstName | string. The account holder's first name. |
middleName | string or null. The account holder's middle name. |
lastName | string. The account holder's last name. |
dateOfBirth | string or null. The account holder's date of birth, in YYYY-MM-DD format. |
phoneNumbers | object. The account holder's phone numbers. See Phone Numbers Object. |
address | object or null. The account holder's address. See Address Object. |
Phone Numbers Object
| Attribute | Description |
|---|---|
mobile | string or null. The mobile phone number. |
work | string or null. The work phone number. |
home | string or null. The home phone number. |
Address Object
| Attribute | Description |
|---|---|
addressLine1 | string. The first line of the address. |
addressLine2 | string or null. The second line of the address. |
city | string. The city. |
state | string or null. The state. |
postalCode | string. The postal code or ZIP code. |
country | string. The country. |
Error Messages
If there is a problem with the request, the response returns the following error:
422: Theaccount_holder_idis missing or not valid. The response includes details of the validation failure.
Updated 7 days ago
