ClientContactDto

Response DTO for client-contact relationship information

Properties

Name	Type	Description
code	string	The unique code for this relationship (uses the contact's code)
The unique code for this relationship (uses the contact's code)
role	string	The role of the contact within this client relationship
The role of the contact within this client relationship
resignedDate	string	Date the contact resigned their officer role for this client (from Companies House). Null while still an active officer.
Date the contact resigned their officer role for this client (from Companies House). Null while still an active officer.
ceasedDate	string	Date the contact ceased being a Person with Significant Control for this client (from Companies House). Null while still an active PSC. Independent of resignation — a person can hold both roles and end them on different dates.
Date the contact ceased being a Person with Significant Control for this client (from Companies House). Null while still an active PSC. Independent of resignation — a person can hold both roles and end them on different dates.
types	array of enum	The type of contact relationship Main Billing Payroll Accounts Director Psc
The type of contact relationship Main Billing Payroll Accounts Director Psc
contact	ContactDto
client	CodeAndNameDto
individualClient	CodeAndNameDto
hasPortalAccess	boolean	Whether this contact has access to the client portal for this client.
Whether this contact has access to the client portal for this client.
amlContactId	string	The contact's ID in the AML platform. Null if not yet pushed.
The contact's ID in the AML platform. Null if not yet pushed.
lastPortalAccessDate	string	When this contact last accessed the client portal for this client.
When this contact last accessed the client portal for this client.
createdDate	string	When the relationship was created
When the relationship was created
updatedDate	string	When the relationship was last updated
When the relationship was last updated

JSON Example

{
  "code": "string",
  "role": "string",
  "resignedDate": "2024-01-01",
  "ceasedDate": "2024-01-01",
  "types": [
    "Main"
  ]
}

Used By Operations

Contained in Schemas

ClientContactDtoPagedResult