Advisers, organisations and lookup data

Directory resources describe the adviser and organisation context available to an integration. Lookup resources provide categories, types and other values used by business records.

Adviser context

The adviser identifier used in UserId must be one the application is permitted to act for. It differs from the client contact identifier in a contact request. Additional adviser information is available through the adviser-details resource when your access permits it.

Organisation context

An application's agreed organisation or subscription access determines which records it can use. Reading an organisation or adviser resource does not by itself grant permission to all related client information.

Cache reference values thoughtfully

For categories, types, enquiry sources and statuses, retain stable identifiers and refresh labels periodically. Do not assume a label is the same in every organisation or that all reference data is editable.

• Advisers
• Adviser details
• Organisations
• Enquiry sources
• Custom statuses

Use the reference catalogue to find the other category and type endpoints.