Account Holder

📘

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 Account Holder endpoints enable you to retrieve and update the details that Thredd holds for a customer (account holder), such as their name, contact details and address. Use it to display or check a customer's details in your own interface.

An account holder is the individual who holds a line of credit. Thredd creates the account holder record when a credit application is approved, and returns its ID, the Thredd Account Holder ID, in the application response. The same ID is used as the customer_id in the Bank Account endpoints.

📘

More Information

For more information about the Credit Service API, see: Thredd Credit API Overview.

Account Holder Endpoints

EndpointDescriptionDocumentationMethod
Get Account Holder DetailsRetrieve the details of an account holder.Get Account Holder DetailsGET
Update Account Holder DetailsUpdate the details of an account holder.Update Account Holder DetailsGET

The Account Holder endpoints can also be viewed in the API Explorer.

❗️

Personal Data

The response contains the customer's personal data, including their name, date of birth, contact details and address. Do not log or cache the response, and protect it in line with your data protection obligations.


Did this page help you?