{"openapi":"3.0.2","paths":{"/clients/{id}":{"get":{"description":"Get a single client by their unique identifier. Expand the RESPONSES 200 below to see the available data for each client.","summary":"Show a client","tags":[],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"The unique identifier for the client."},{"name":"accept-version","in":"header","required":true,"schema":{"type":"string","enum":["1.0.0"]}}],"operationId":"getClient","responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the client."},"object":{"type":"string","enum":["client"]},"name":{"type":"string","description":"The name of the client."},"state":{"type":"string","enum":["PROSPECT","EXISTING","ARCHIVED","DISCARDED"]},"referenceNumber":{"type":"string","description":"The reference number of the client."},"category":{"type":"string","enum":["INDIVIDUAL","ORGANISATION","SOLE_TRADER"],"description":"The category of the client. Will determine the type of entity that is related to this client."},"entity":{"oneOf":[{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the individual."},"object":{"type":"string","enum":["individual"]},"firstName":{"type":"string","description":"The first name of the individual."},"middleName":{"type":"string","description":"The middle name of the individual."},"lastName":{"type":"string","description":"The last name of the individual."},"email":{"type":"string","description":"The email address of the individual."},"residentialAddress":{"type":"object","properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"description":"The residential address of the individual."},"birth":{"type":"object","properties":{"day":{"type":"number"},"month":{"type":"number"},"year":{"type":"number"}},"required":["year"],"description":"The birth date of the individual. Split into parts as the full date is not always available."},"client":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the client."}},"required":["links","id"],"description":"A reference to the client associated with this individual, if one exists."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["links","id","object","firstName","lastName","createdAt","updatedAt"],"description":"An individual person."},{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this organisation"},"web":{"type":"string","format":"uri","description":"The web url for this organisation"},"relatedParties":{"type":"string","format":"uri","description":"The API url for the related parties of this organisation"}},"required":["self","web","relatedParties"]},"id":{"type":"string","description":"The unique identifier for the organisation."},"object":{"type":"string","enum":["organisation"]},"name":{"type":"string","description":"The name of the organisation."},"companyNumber":{"type":"string","description":"The company number of the organisation. Populated when the company was imported via Companies House UK"},"identifyingNumber":{"type":"string","description":"The identifying number of the organisation. Used when company has been created without Companies House UK"},"organisationType":{"type":"string","enum":["COMPANY","NON_PROFIT","TRUST","OTHER"],"description":"The type of the organisation."},"organisationSubType":{"type":"string","description":"The sub type of the organisation."},"registeredAddress":{"type":"object","properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"description":"The registered address of the organisation."},"tradingAddress":{"type":"object","properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"description":"The trading address of the organisation."},"client":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the client."}},"required":["links","id"],"description":"A reference to the client associated with this organisation, if one exists."},"relatedPartiesCount":{"type":"number","description":"The count of related parties for this organisation. Only included on single organisation GET."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["links","id","object","name","organisationType","relatedPartiesCount","createdAt","updatedAt"],"description":"An organisation."},{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the sole trader."},"object":{"type":"string","enum":["sole_trader"]},"tradingName":{"type":"string","description":"The trading name of the sole trader."},"individual":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the individual."},"object":{"type":"string","enum":["individual"]},"firstName":{"type":"string","description":"The first name of the individual."},"middleName":{"type":"string","description":"The middle name of the individual."},"lastName":{"type":"string","description":"The last name of the individual."},"email":{"type":"string","description":"The email address of the individual."},"residentialAddress":{"type":"object","properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"description":"The residential address of the individual."},"birth":{"type":"object","properties":{"day":{"type":"number"},"month":{"type":"number"},"year":{"type":"number"}},"required":["year"],"description":"The birth date of the individual. Split into parts as the full date is not always available."},"client":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the client."}},"required":["links","id"],"description":"A reference to the client associated with this individual, if one exists."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["links","id","object","firstName","lastName","createdAt","updatedAt"],"description":"The individual related to this sole trader."},"client":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the client."}},"required":["links","id"],"description":"A reference to the client associated with this sole trader, if one exists."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["links","id","object","individual","createdAt","updatedAt"],"description":"A sole trader, which is an individual with an associated trading name."}],"description":"The entity this client represents. Will be determined by the category of the client."},"amlDeterminationStatus":{"oneOf":[{"type":"string","enum":["IN_PROGRESS","COMPLETE"]},{"type":"string","enum":["NOT_STARTED"]}],"description":"The status of the clients AML determination. Will be NOT_STARTED if no determination has ever been made for the client."},"lastAmlDetermination":{"type":"object","properties":{"riskLevel":{"type":"string","enum":["PENDING","LOW","NORMAL","MEDIUM","HIGH"],"description":"The risk level of the client based on the last AML determination."},"completedAt":{"type":"string","format":"date-time"}},"required":["riskLevel","completedAt"],"description":"The result of the last AML determination for this client. Will be unset if no determination has been made yet."},"lastModifiedAt":{"type":"string","format":"date-time","description":"When the client or its related entity or aml determination was last modified."},"nextReviewDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"The date of the next review for this client in ISO-8601 format (YYYY-MM-DD). This is optional, as it will be set when an AML determination has been completed for the client."},"partner":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the staff member."},"name":{"type":"string","description":"The name of the staff member."}},"required":["id","name"],"description":"A reference to a staff member."},"manager":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the staff member."},"name":{"type":"string","description":"The name of the staff member."}},"required":["id","name"],"description":"A reference to a staff member."},"businessUnit":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the business unit."},"name":{"type":"string","description":"The name of the business unit."},"type":{"type":"string","description":"The type of the business unit."}},"required":["id","name","type"],"description":"A reference to a business unit."},"services":{"type":"array","items":{"type":"string"},"description":"The services that this client is receiving."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["links","id","object","name","state","category","entity","amlDeterminationStatus","lastModifiedAt","services","createdAt","updatedAt"],"description":"The main response data"}},"required":["data"]}}}},"404":{"description":"404"}}},"patch":{"description":"Update a client. Only provided fields will be updated. Cannot modify the underlying entity (individual/organisation/soleTrader).","summary":"Update a client","tags":[],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"The unique identifier for the client."},{"name":"accept-version","in":"header","required":true,"schema":{"type":"string","enum":["1.0.0"]}}],"operationId":"updateClient","requestBody":{"description":"Body","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["PROSPECT","EXISTING"],"description":"The relationship status of your client."},"serviceIds":{"type":"array","items":{"type":"string"},"description":"The IDs of the services that this client is receiving."},"partnerId":{"type":"string","nullable":true,"description":"A reference to a staff member."},"managerId":{"type":"string","nullable":true,"description":"A reference to a staff member."},"businessUnitId":{"type":"string","nullable":true,"description":"A reference to a business unit."},"referenceNumber":{"type":"string","nullable":true,"description":"Your unique reference number."},"nextReviewDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","nullable":true,"description":"The date of the next review for this client in ISO-8601 format (YYYY-MM-DD)."}},"description":"Fields to update for a client. Only provided fields will be updated. Cannot modify the underlying entity (individual/organisation/soleTrader)."}}}},"responses":{"200":{"description":"Client updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the client."},"object":{"type":"string","enum":["client"]},"name":{"type":"string","description":"The name of the client."},"state":{"type":"string","enum":["PROSPECT","EXISTING","ARCHIVED","DISCARDED"]},"referenceNumber":{"type":"string","description":"The reference number of the client."},"category":{"type":"string","enum":["INDIVIDUAL","ORGANISATION","SOLE_TRADER"],"description":"The category of the client. Will determine the type of entity that is related to this client."},"entity":{"oneOf":[{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the individual."},"object":{"type":"string","enum":["individual"]},"firstName":{"type":"string","description":"The first name of the individual."},"middleName":{"type":"string","description":"The middle name of the individual."},"lastName":{"type":"string","description":"The last name of the individual."},"email":{"type":"string","description":"The email address of the individual."},"residentialAddress":{"type":"object","properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"description":"The residential address of the individual."},"birth":{"type":"object","properties":{"day":{"type":"number"},"month":{"type":"number"},"year":{"type":"number"}},"required":["year"],"description":"The birth date of the individual. Split into parts as the full date is not always available."},"client":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the client."}},"required":["links","id"],"description":"A reference to the client associated with this individual, if one exists."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["links","id","object","firstName","lastName","createdAt","updatedAt"],"description":"An individual person."},{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this organisation"},"web":{"type":"string","format":"uri","description":"The web url for this organisation"},"relatedParties":{"type":"string","format":"uri","description":"The API url for the related parties of this organisation"}},"required":["self","web","relatedParties"]},"id":{"type":"string","description":"The unique identifier for the organisation."},"object":{"type":"string","enum":["organisation"]},"name":{"type":"string","description":"The name of the organisation."},"companyNumber":{"type":"string","description":"The company number of the organisation. Populated when the company was imported via Companies House UK"},"identifyingNumber":{"type":"string","description":"The identifying number of the organisation. Used when company has been created without Companies House UK"},"organisationType":{"type":"string","enum":["COMPANY","NON_PROFIT","TRUST","OTHER"],"description":"The type of the organisation."},"organisationSubType":{"type":"string","description":"The sub type of the organisation."},"registeredAddress":{"type":"object","properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"description":"The registered address of the organisation."},"tradingAddress":{"type":"object","properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"description":"The trading address of the organisation."},"client":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the client."}},"required":["links","id"],"description":"A reference to the client associated with this organisation, if one exists."},"relatedPartiesCount":{"type":"number","description":"The count of related parties for this organisation. Only included on single organisation GET."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["links","id","object","name","organisationType","relatedPartiesCount","createdAt","updatedAt"],"description":"An organisation."},{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the sole trader."},"object":{"type":"string","enum":["sole_trader"]},"tradingName":{"type":"string","description":"The trading name of the sole trader."},"individual":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the individual."},"object":{"type":"string","enum":["individual"]},"firstName":{"type":"string","description":"The first name of the individual."},"middleName":{"type":"string","description":"The middle name of the individual."},"lastName":{"type":"string","description":"The last name of the individual."},"email":{"type":"string","description":"The email address of the individual."},"residentialAddress":{"type":"object","properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"description":"The residential address of the individual."},"birth":{"type":"object","properties":{"day":{"type":"number"},"month":{"type":"number"},"year":{"type":"number"}},"required":["year"],"description":"The birth date of the individual. Split into parts as the full date is not always available."},"client":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the client."}},"required":["links","id"],"description":"A reference to the client associated with this individual, if one exists."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["links","id","object","firstName","lastName","createdAt","updatedAt"],"description":"The individual related to this sole trader."},"client":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the client."}},"required":["links","id"],"description":"A reference to the client associated with this sole trader, if one exists."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["links","id","object","individual","createdAt","updatedAt"],"description":"A sole trader, which is an individual with an associated trading name."}],"description":"The entity this client represents. Will be determined by the category of the client."},"amlDeterminationStatus":{"oneOf":[{"type":"string","enum":["IN_PROGRESS","COMPLETE"]},{"type":"string","enum":["NOT_STARTED"]}],"description":"The status of the clients AML determination. Will be NOT_STARTED if no determination has ever been made for the client."},"lastAmlDetermination":{"type":"object","properties":{"riskLevel":{"type":"string","enum":["PENDING","LOW","NORMAL","MEDIUM","HIGH"],"description":"The risk level of the client based on the last AML determination."},"completedAt":{"type":"string","format":"date-time"}},"required":["riskLevel","completedAt"],"description":"The result of the last AML determination for this client. Will be unset if no determination has been made yet."},"lastModifiedAt":{"type":"string","format":"date-time","description":"When the client or its related entity or aml determination was last modified."},"nextReviewDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"The date of the next review for this client in ISO-8601 format (YYYY-MM-DD). This is optional, as it will be set when an AML determination has been completed for the client."},"partner":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the staff member."},"name":{"type":"string","description":"The name of the staff member."}},"required":["id","name"],"description":"A reference to a staff member."},"manager":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the staff member."},"name":{"type":"string","description":"The name of the staff member."}},"required":["id","name"],"description":"A reference to a staff member."},"businessUnit":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the business unit."},"name":{"type":"string","description":"The name of the business unit."},"type":{"type":"string","description":"The type of the business unit."}},"required":["id","name","type"],"description":"A reference to a business unit."},"services":{"type":"array","items":{"type":"string"},"description":"The services that this client is receiving."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["links","id","object","name","state","category","entity","amlDeterminationStatus","lastModifiedAt","services","createdAt","updatedAt"],"description":"The main response data"}},"required":["data"],"description":"Client updated successfully"}}}},"404":{"description":"404"},"500":{"description":"500"}}}},"/clients":{"get":{"description":"Get a list of all clients. Expand the RESPONSES 200 below to see the available data for each client.","summary":"List clients","tags":[],"parameters":[{"name":"accept-version","in":"header","required":true,"schema":{"type":"string","enum":["1.0.0"]}},{"name":"cursor","in":"query","description":"Cursor for paginated requests","schema":{"type":"string"}},{"name":"limit","in":"query","description":"The number of results per page","schema":{"default":50,"type":"integer","maximum":200,"nullable":true}},{"name":"sinceModifiedAt","in":"query","description":"Optionally, filter to clients that that have a lastModifiedAt since this date.","schema":{"type":"string","format":"date-time","nullable":true}}],"operationId":"getClients","responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the client."},"object":{"type":"string","enum":["client"]},"name":{"type":"string","description":"The name of the client."},"state":{"type":"string","enum":["PROSPECT","EXISTING","ARCHIVED","DISCARDED"]},"referenceNumber":{"type":"string","description":"The reference number of the client."},"category":{"type":"string","enum":["INDIVIDUAL","ORGANISATION","SOLE_TRADER"],"description":"The category of the client. Will determine the type of entity that is related to this client."},"entity":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the referenced entity."},"object":{"type":"string","enum":["individual","sole_trader","organisation"]}},"required":["links","id","object"],"description":"A reference to the entity related to this client. The object will be determined by the category of the client."},"amlDeterminationStatus":{"oneOf":[{"type":"string","enum":["IN_PROGRESS","COMPLETE"]},{"type":"string","enum":["NOT_STARTED"]}],"description":"The status of the clients AML determination. Will be NOT_STARTED if no determination has ever been made for the client."},"lastAmlDetermination":{"type":"object","properties":{"riskLevel":{"type":"string","enum":["PENDING","LOW","NORMAL","MEDIUM","HIGH"],"description":"The risk level of the client based on the last AML determination."},"completedAt":{"type":"string","format":"date-time"}},"required":["riskLevel","completedAt"],"description":"The result of the last AML determination for this client. Will be unset if no determination has been made yet."},"lastModifiedAt":{"type":"string","format":"date-time","description":"When the client or its related entity or aml determination was last modified."},"nextReviewDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"The date of the next review for this client in ISO-8601 format (YYYY-MM-DD). This is optional, as it will be set when an AML determination has been completed for the client."}},"required":["links","id","object","name","state","category","entity","amlDeterminationStatus","lastModifiedAt"]},"description":"The main response data"},"meta":{"type":"object","properties":{"next_cursor":{"type":"string","description":"The cursor for the next page of results."},"total":{"type":"number","description":"The total number of results"}},"required":["total"]}},"required":["data","meta"]}}}}}},"post":{"description":"Create a client.","summary":"Create a client","tags":[],"parameters":[{"name":"accept-version","in":"header","required":true,"schema":{"type":"string","enum":["1.0.0"]}}],"operationId":"createClient","requestBody":{"description":"Body","content":{"application/json":{"schema":{"type":"object","properties":{"partnerId":{"type":"string","description":"A reference to a staff member."},"managerId":{"type":"string","description":"A reference to a staff member."},"businessUnitId":{"type":"string","description":"A reference to a business unit."},"serviceIds":{"default":[],"type":"array","items":{"type":"string"},"description":"The IDs of the services that this client is receiving."},"status":{"type":"string","enum":["PROSPECT","EXISTING"],"description":"The relationship status of your client."},"referenceNumber":{"type":"string","description":"Your unique reference number."},"nextReviewDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"The date of the next review for this client in ISO-8601 format (YYYY-MM-DD)."},"entity":{"oneOf":[{"type":"object","properties":{"object":{"type":"string","enum":["individual"]},"firstName":{"type":"string","description":"The first name of the individual."},"middleName":{"type":"string","description":"The middle name of the individual."},"lastName":{"type":"string","description":"The last name of the individual."},"email":{"type":"string","description":"The email address of the individual."},"residentialAddress":{"type":"object","properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"description":"The residential address of the individual."},"birth":{"type":"object","properties":{"day":{"type":"number"},"month":{"type":"number"},"year":{"type":"number"}},"required":["day","month","year"],"description":"The birth date of the individual. If provided, all fields (day, month, year) must be specified."}},"required":["object","firstName","lastName"],"description":"Create an individual person."},{"type":"object","properties":{"object":{"type":"string","enum":["sole_trader"]},"tradingName":{"type":"string","description":"The trading name of the sole trader."},"individual":{"type":"object","properties":{"firstName":{"type":"string","description":"The first name of the individual."},"middleName":{"type":"string","description":"The middle name of the individual."},"lastName":{"type":"string","description":"The last name of the individual."},"email":{"type":"string","description":"The email address of the individual."},"residentialAddress":{"type":"object","properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"description":"The residential address of the individual."},"birth":{"type":"object","properties":{"day":{"type":"number"},"month":{"type":"number"},"year":{"type":"number"}},"required":["day","month","year"],"description":"The birth date of the individual. If provided, all fields (day, month, year) must be specified."}},"required":["firstName","lastName"],"description":"The individual related to this sole trader."}},"required":["object","individual"],"description":"Create a sole trader, which is an individual with an associated trading name."},{"type":"object","properties":{"object":{"type":"string","enum":["import_uk_company"]},"companyNumber":{"type":"string","description":"The identifying number of the company at Companies House UK"},"tradingAddress":{"type":"object","properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"description":"The trading address of the organisation."}},"required":["object","companyNumber"],"description":"Import a company from Companies House UK"},{"type":"object","properties":{"object":{"type":"string","enum":["organisation"]},"name":{"type":"string","description":"The name of the organisation."},"type":{"type":"string","enum":["COMPANY","NON_PROFIT","TRUST","OTHER"],"description":"The type of the organisation."},"subType":{"type":"string","description":"The sub type of the organisation."},"identifyingNumber":{"type":"string","description":"The identifying number of the organisation."},"registeredAddress":{"type":"object","properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"description":"The registered address of the organisation."},"tradingAddress":{"type":"object","properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"description":"The trading address of the organisation."}},"required":["object","name","type"],"description":"Create an organisation that is not from Companies House UK. All required fields must be provided manually."}],"description":"The entity this client represents. Will be determined by the category of the client."}},"required":["status","entity"]}}}},"responses":{"201":{"description":"Client created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the client."},"object":{"type":"string","enum":["client"]},"name":{"type":"string","description":"The name of the client."},"state":{"type":"string","enum":["PROSPECT","EXISTING","ARCHIVED","DISCARDED"]},"referenceNumber":{"type":"string","description":"The reference number of the client."},"category":{"type":"string","enum":["INDIVIDUAL","ORGANISATION","SOLE_TRADER"],"description":"The category of the client. Will determine the type of entity that is related to this client."},"entity":{"oneOf":[{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the individual."},"object":{"type":"string","enum":["individual"]},"firstName":{"type":"string","description":"The first name of the individual."},"middleName":{"type":"string","description":"The middle name of the individual."},"lastName":{"type":"string","description":"The last name of the individual."},"email":{"type":"string","description":"The email address of the individual."},"residentialAddress":{"type":"object","properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"description":"The residential address of the individual."},"birth":{"type":"object","properties":{"day":{"type":"number"},"month":{"type":"number"},"year":{"type":"number"}},"required":["year"],"description":"The birth date of the individual. Split into parts as the full date is not always available."},"client":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the client."}},"required":["links","id"],"description":"A reference to the client associated with this individual, if one exists."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["links","id","object","firstName","lastName","createdAt","updatedAt"],"description":"An individual person."},{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this organisation"},"web":{"type":"string","format":"uri","description":"The web url for this organisation"},"relatedParties":{"type":"string","format":"uri","description":"The API url for the related parties of this organisation"}},"required":["self","web","relatedParties"]},"id":{"type":"string","description":"The unique identifier for the organisation."},"object":{"type":"string","enum":["organisation"]},"name":{"type":"string","description":"The name of the organisation."},"companyNumber":{"type":"string","description":"The company number of the organisation. Populated when the company was imported via Companies House UK"},"identifyingNumber":{"type":"string","description":"The identifying number of the organisation. Used when company has been created without Companies House UK"},"organisationType":{"type":"string","enum":["COMPANY","NON_PROFIT","TRUST","OTHER"],"description":"The type of the organisation."},"organisationSubType":{"type":"string","description":"The sub type of the organisation."},"registeredAddress":{"type":"object","properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"description":"The registered address of the organisation."},"tradingAddress":{"type":"object","properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"description":"The trading address of the organisation."},"client":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the client."}},"required":["links","id"],"description":"A reference to the client associated with this organisation, if one exists."},"relatedPartiesCount":{"type":"number","description":"The count of related parties for this organisation. Only included on single organisation GET."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["links","id","object","name","organisationType","relatedPartiesCount","createdAt","updatedAt"],"description":"An organisation."},{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the sole trader."},"object":{"type":"string","enum":["sole_trader"]},"tradingName":{"type":"string","description":"The trading name of the sole trader."},"individual":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the individual."},"object":{"type":"string","enum":["individual"]},"firstName":{"type":"string","description":"The first name of the individual."},"middleName":{"type":"string","description":"The middle name of the individual."},"lastName":{"type":"string","description":"The last name of the individual."},"email":{"type":"string","description":"The email address of the individual."},"residentialAddress":{"type":"object","properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"description":"The residential address of the individual."},"birth":{"type":"object","properties":{"day":{"type":"number"},"month":{"type":"number"},"year":{"type":"number"}},"required":["year"],"description":"The birth date of the individual. Split into parts as the full date is not always available."},"client":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the client."}},"required":["links","id"],"description":"A reference to the client associated with this individual, if one exists."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["links","id","object","firstName","lastName","createdAt","updatedAt"],"description":"The individual related to this sole trader."},"client":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the client."}},"required":["links","id"],"description":"A reference to the client associated with this sole trader, if one exists."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["links","id","object","individual","createdAt","updatedAt"],"description":"A sole trader, which is an individual with an associated trading name."}],"description":"The entity this client represents. Will be determined by the category of the client."},"amlDeterminationStatus":{"oneOf":[{"type":"string","enum":["IN_PROGRESS","COMPLETE"]},{"type":"string","enum":["NOT_STARTED"]}],"description":"The status of the clients AML determination. Will be NOT_STARTED if no determination has ever been made for the client."},"lastAmlDetermination":{"type":"object","properties":{"riskLevel":{"type":"string","enum":["PENDING","LOW","NORMAL","MEDIUM","HIGH"],"description":"The risk level of the client based on the last AML determination."},"completedAt":{"type":"string","format":"date-time"}},"required":["riskLevel","completedAt"],"description":"The result of the last AML determination for this client. Will be unset if no determination has been made yet."},"lastModifiedAt":{"type":"string","format":"date-time","description":"When the client or its related entity or aml determination was last modified."},"nextReviewDate":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"The date of the next review for this client in ISO-8601 format (YYYY-MM-DD). This is optional, as it will be set when an AML determination has been completed for the client."},"partner":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the staff member."},"name":{"type":"string","description":"The name of the staff member."}},"required":["id","name"],"description":"A reference to a staff member."},"manager":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the staff member."},"name":{"type":"string","description":"The name of the staff member."}},"required":["id","name"],"description":"A reference to a staff member."},"businessUnit":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the business unit."},"name":{"type":"string","description":"The name of the business unit."},"type":{"type":"string","description":"The type of the business unit."}},"required":["id","name","type"],"description":"A reference to a business unit."},"services":{"type":"array","items":{"type":"string"},"description":"The services that this client is receiving."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["links","id","object","name","state","category","entity","amlDeterminationStatus","lastModifiedAt","services","createdAt","updatedAt"],"description":"The main response data"}},"required":["data"],"description":"Client created successfully"}}}},"409":{"description":"409"},"500":{"description":"500"}}}},"/firm":{"get":{"description":"Get the firm associated with the authenticated API key. Expand the RESPONSES 200 below to see the available data for the firm.","summary":"Show the authenticated user's firm","tags":[],"parameters":[{"name":"accept-version","in":"header","required":true,"schema":{"type":"string","enum":["1.0.0"]}}],"operationId":"getFirm","responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the firm."},"object":{"type":"string","enum":["firm"]},"name":{"type":"string","description":"The name of the firm."},"services":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the service."},"name":{"type":"string","description":"The name of the service."}},"required":["id","name"],"description":"A service offered by the firm."},"description":"The services offered by the firm."},"businessUnits":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the business unit."},"name":{"type":"string","description":"The name of the business unit."},"type":{"type":"string","description":"The type of the business unit."}},"required":["id","name","type"],"description":"A business unit within the firm."},"description":"The business units within the firm."},"staff":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the staff member."},"firstName":{"type":"string","description":"The first name of the staff member."},"lastName":{"type":"string","description":"The last name of the staff member."},"isPartner":{"type":"boolean","description":"Whether the staff member is a partner."},"isManager":{"type":"boolean","description":"Whether the staff member is a manager."},"isReviewer":{"type":"boolean","description":"Whether the staff member is a reviewer."}},"required":["id","firstName","lastName","isPartner","isManager","isReviewer"],"description":"A staff member of the firm."},"description":"The staff members of the firm."},"mlroStaffId":{"type":"string","nullable":true,"description":"The MLRO staff member ID."},"createdAt":{"type":"string","format":"date-time","description":"When the firm was created."},"updatedAt":{"type":"string","format":"date-time","description":"When the firm was last updated."}},"required":["links","id","object","name","services","businessUnits","staff","mlroStaffId","createdAt","updatedAt"],"description":"The main response data"}},"required":["data"]}}}}}}},"/individuals":{"get":{"description":"Get a list of all individuals.","summary":"List individuals","tags":[],"parameters":[{"name":"accept-version","in":"header","required":true,"schema":{"type":"string","enum":["1.0.0"]}},{"name":"cursor","in":"query","description":"Cursor for paginated requests","schema":{"type":"string"}},{"name":"limit","in":"query","description":"The number of results per page","schema":{"default":50,"type":"integer","maximum":200,"nullable":true}}],"operationId":"getIndividuals","responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the individual."},"object":{"type":"string","enum":["individual"]},"firstName":{"type":"string","description":"The first name of the individual."},"middleName":{"type":"string","description":"The middle name of the individual."},"lastName":{"type":"string","description":"The last name of the individual."},"email":{"type":"string","description":"The email address of the individual."},"residentialAddress":{"type":"object","properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"description":"The residential address of the individual."},"birth":{"type":"object","properties":{"day":{"type":"number"},"month":{"type":"number"},"year":{"type":"number"}},"required":["year"],"description":"The birth date of the individual. Split into parts as the full date is not always available."},"client":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the client."}},"required":["links","id"],"description":"A reference to the client associated with this individual, if one exists."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["links","id","object","firstName","lastName","createdAt","updatedAt"],"description":"An individual person."},"description":"The main response data"},"meta":{"type":"object","properties":{"next_cursor":{"type":"string","description":"The cursor for the next page of results."},"total":{"type":"number","description":"The total number of results"}},"required":["total"]}},"required":["data","meta"]}}}}}}},"/individuals/{id}":{"get":{"description":"Get a single individual by their unique identifier.","summary":"Show an individual","tags":[],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"The unique identifier for the individual."},{"name":"accept-version","in":"header","required":true,"schema":{"type":"string","enum":["1.0.0"]}}],"operationId":"getIndividual","responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the individual."},"object":{"type":"string","enum":["individual"]},"firstName":{"type":"string","description":"The first name of the individual."},"middleName":{"type":"string","description":"The middle name of the individual."},"lastName":{"type":"string","description":"The last name of the individual."},"email":{"type":"string","description":"The email address of the individual."},"residentialAddress":{"type":"object","properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"description":"The residential address of the individual."},"birth":{"type":"object","properties":{"day":{"type":"number"},"month":{"type":"number"},"year":{"type":"number"}},"required":["year"],"description":"The birth date of the individual. Split into parts as the full date is not always available."},"client":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the client."}},"required":["links","id"],"description":"A reference to the client associated with this individual, if one exists."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["links","id","object","firstName","lastName","createdAt","updatedAt"],"description":"The main response data"}},"required":["data"]}}}},"404":{"description":"404"}}},"patch":{"description":"Update an individual. Only provided fields will be updated.","summary":"Update an individual","tags":[],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"The unique identifier for the individual."},{"name":"accept-version","in":"header","required":true,"schema":{"type":"string","enum":["1.0.0"]}}],"operationId":"updateIndividual","requestBody":{"description":"Body","content":{"application/json":{"schema":{"type":"object","properties":{"firstName":{"type":"string","description":"The first name of the individual."},"middleName":{"type":"string","nullable":true,"description":"The middle name of the individual."},"lastName":{"type":"string","description":"The last name of the individual."},"email":{"type":"string","format":"email","nullable":true,"description":"The email address of the individual."},"residentialAddress":{"type":"object","properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"description":"The residential address of the individual.","nullable":true},"birth":{"type":"object","properties":{"day":{"type":"number"},"month":{"type":"number"},"year":{"type":"number"}},"required":["day","month","year"],"nullable":true,"description":"The birth date of the individual. If provided, all fields (day, month, year) must be specified."}},"description":"Fields to update for an individual. Only provided fields will be updated."}}}},"responses":{"200":{"description":"Individual updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the individual."},"object":{"type":"string","enum":["individual"]},"firstName":{"type":"string","description":"The first name of the individual."},"middleName":{"type":"string","description":"The middle name of the individual."},"lastName":{"type":"string","description":"The last name of the individual."},"email":{"type":"string","description":"The email address of the individual."},"residentialAddress":{"type":"object","properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"description":"The residential address of the individual."},"birth":{"type":"object","properties":{"day":{"type":"number"},"month":{"type":"number"},"year":{"type":"number"}},"required":["year"],"description":"The birth date of the individual. Split into parts as the full date is not always available."},"client":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the client."}},"required":["links","id"],"description":"A reference to the client associated with this individual, if one exists."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["links","id","object","firstName","lastName","createdAt","updatedAt"],"description":"The main response data"}},"required":["data"],"description":"Individual updated successfully"}}}},"404":{"description":"404"},"500":{"description":"500"}}}},"/organisations":{"get":{"description":"Get a list of all organisations.","summary":"List organisations","tags":[],"parameters":[{"name":"accept-version","in":"header","required":true,"schema":{"type":"string","enum":["1.0.0"]}},{"name":"cursor","in":"query","description":"Cursor for paginated requests","schema":{"type":"string"}},{"name":"limit","in":"query","description":"The number of results per page","schema":{"default":50,"type":"integer","maximum":200,"nullable":true}}],"operationId":"getOrganisations","responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this organisation"},"web":{"type":"string","format":"uri","description":"The web url for this organisation"},"relatedParties":{"type":"string","format":"uri","description":"The API url for the related parties of this organisation"}},"required":["self","web","relatedParties"]},"id":{"type":"string","description":"The unique identifier for the organisation."},"object":{"type":"string","enum":["organisation"]},"name":{"type":"string","description":"The name of the organisation."},"companyNumber":{"type":"string","description":"The company number of the organisation. Populated when the company was imported via Companies House UK"},"identifyingNumber":{"type":"string","description":"The identifying number of the organisation. Used when company has been created without Companies House UK"},"organisationType":{"type":"string","enum":["COMPANY","NON_PROFIT","TRUST","OTHER"],"description":"The type of the organisation."},"organisationSubType":{"type":"string","description":"The sub type of the organisation."},"registeredAddress":{"type":"object","properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"description":"The registered address of the organisation."},"tradingAddress":{"type":"object","properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"description":"The trading address of the organisation."},"client":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the client."}},"required":["links","id"],"description":"A reference to the client associated with this organisation, if one exists."},"relatedPartiesCount":{"type":"number","description":"The count of related parties for this organisation. Only included on single organisation GET."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["links","id","object","name","organisationType","relatedPartiesCount","createdAt","updatedAt"],"description":"An organisation."},"description":"The main response data"},"meta":{"type":"object","properties":{"next_cursor":{"type":"string","description":"The cursor for the next page of results."},"total":{"type":"number","description":"The total number of results"}},"required":["total"]}},"required":["data","meta"]}}}}}}},"/organisations/{id}":{"get":{"description":"Get a single organisation by its unique identifier.","summary":"Show an organisation","tags":[],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"The unique identifier for the organisation."},{"name":"accept-version","in":"header","required":true,"schema":{"type":"string","enum":["1.0.0"]}}],"operationId":"getOrganisation","responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this organisation"},"web":{"type":"string","format":"uri","description":"The web url for this organisation"},"relatedParties":{"type":"string","format":"uri","description":"The API url for the related parties of this organisation"}},"required":["self","web","relatedParties"]},"id":{"type":"string","description":"The unique identifier for the organisation."},"object":{"type":"string","enum":["organisation"]},"name":{"type":"string","description":"The name of the organisation."},"companyNumber":{"type":"string","description":"The company number of the organisation. Populated when the company was imported via Companies House UK"},"identifyingNumber":{"type":"string","description":"The identifying number of the organisation. Used when company has been created without Companies House UK"},"organisationType":{"type":"string","enum":["COMPANY","NON_PROFIT","TRUST","OTHER"],"description":"The type of the organisation."},"organisationSubType":{"type":"string","description":"The sub type of the organisation."},"registeredAddress":{"type":"object","properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"description":"The registered address of the organisation."},"tradingAddress":{"type":"object","properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"description":"The trading address of the organisation."},"client":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the client."}},"required":["links","id"],"description":"A reference to the client associated with this organisation, if one exists."},"relatedPartiesCount":{"type":"number","description":"The count of related parties for this organisation. Only included on single organisation GET."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["links","id","object","name","organisationType","relatedPartiesCount","createdAt","updatedAt"],"description":"The main response data"}},"required":["data"]}}}},"404":{"description":"404"}}},"patch":{"description":"Update an organisation. Only provided fields will be updated. Cannot modify Companies House organisation fields.","summary":"Update an organisation","tags":[],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"The unique identifier for the organisation."},{"name":"accept-version","in":"header","required":true,"schema":{"type":"string","enum":["1.0.0"]}}],"operationId":"updateOrganisation","requestBody":{"description":"Body","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the organisation."},"organisationSubType":{"type":"string","nullable":true,"description":"The sub type of the organisation."},"identifyingNumber":{"type":"string","nullable":true,"description":"The identifying number of the organisation. Used when company has been created without Companies House UK"},"registeredAddress":{"type":"object","properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"description":"The registered address of the organisation.","nullable":true},"tradingAddress":{"type":"object","properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"description":"The trading address of the organisation.","nullable":true}},"description":"Fields to update for an organisation. Only provided fields will be updated. Cannot modify Companies House organisation fields."}}}},"responses":{"200":{"description":"Organisation updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this organisation"},"web":{"type":"string","format":"uri","description":"The web url for this organisation"},"relatedParties":{"type":"string","format":"uri","description":"The API url for the related parties of this organisation"}},"required":["self","web","relatedParties"]},"id":{"type":"string","description":"The unique identifier for the organisation."},"object":{"type":"string","enum":["organisation"]},"name":{"type":"string","description":"The name of the organisation."},"companyNumber":{"type":"string","description":"The company number of the organisation. Populated when the company was imported via Companies House UK"},"identifyingNumber":{"type":"string","description":"The identifying number of the organisation. Used when company has been created without Companies House UK"},"organisationType":{"type":"string","enum":["COMPANY","NON_PROFIT","TRUST","OTHER"],"description":"The type of the organisation."},"organisationSubType":{"type":"string","description":"The sub type of the organisation."},"registeredAddress":{"type":"object","properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"description":"The registered address of the organisation."},"tradingAddress":{"type":"object","properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"description":"The trading address of the organisation."},"client":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the client."}},"required":["links","id"],"description":"A reference to the client associated with this organisation, if one exists."},"relatedPartiesCount":{"type":"number","description":"The count of related parties for this organisation. Only included on single organisation GET."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["links","id","object","name","organisationType","relatedPartiesCount","createdAt","updatedAt"],"description":"The main response data"}},"required":["data"],"description":"Organisation updated successfully"}}}},"403":{"description":"403"},"404":{"description":"404"},"500":{"description":"500"}}}},"/organisations/{organisationId}/related-parties":{"get":{"description":"Get a list of all related parties for an organisation.","summary":"List related parties","tags":[],"parameters":[{"name":"organisationId","in":"path","required":true,"schema":{"type":"string"},"description":"The unique identifier for the organisation."},{"name":"accept-version","in":"header","required":true,"schema":{"type":"string","enum":["1.0.0"]}}],"operationId":"getRelatedParties","responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the related party relationship."},"object":{"type":"string","enum":["related_party"]},"partyType":{"type":"string","enum":["INDIVIDUAL","ORGANISATION"],"description":"The type of related party. Determines the type of entity that is referenced."},"entity":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the referenced entity."},"object":{"type":"string","enum":["individual","organisation"]}},"required":["links","id","object"],"description":"A reference to the entity that is the related party."},"name":{"type":"string","description":"The name of the related party."},"roles":{"type":"array","items":{"type":"string","enum":["DIRECTOR","PSC","SHAREHOLDER","BENEFICIAL_OWNER","TRUSTEE","NOMINEE","SECRETARY","OTHER"]},"description":"The roles of this related party in the parent organisation."},"isClient":{"type":"boolean","description":"Whether this related party is also a client."},"createdAt":{"type":"string","format":"date-time"}},"required":["links","id","object","partyType","entity","name","roles","isClient","createdAt"],"description":"A related party of an organisation."},"description":"The main response data"},"meta":{"type":"object","properties":{"next_cursor":{"type":"string","description":"The cursor for the next page of results."},"total":{"type":"number","description":"The total number of results"}},"required":["total"]}},"required":["data","meta"]}}}},"404":{"description":"404"}}},"post":{"description":"Add an existing individual or organisation as a related party to this organisation.","summary":"Create a related party","tags":[],"parameters":[{"name":"organisationId","in":"path","required":true,"schema":{"type":"string"},"description":"The unique identifier for the organisation."},{"name":"accept-version","in":"header","required":true,"schema":{"type":"string","enum":["1.0.0"]}}],"operationId":"createRelatedParty","requestBody":{"description":"Body","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"object":{"type":"string","enum":["individual"]},"firstName":{"type":"string","description":"The first name of the individual."},"middleName":{"type":"string","description":"The middle name of the individual."},"lastName":{"type":"string","description":"The last name of the individual."},"email":{"type":"string","description":"The email address of the individual."},"residentialAddress":{"type":"object","properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"description":"The residential address of the individual."},"birth":{"type":"object","properties":{"day":{"type":"number"},"month":{"type":"number"},"year":{"type":"number"}},"required":["day","month","year"],"description":"The birth date of the individual. If provided, all fields (day, month, year) must be specified."},"roles":{"default":[],"type":"array","items":{"type":"string","enum":["DIRECTOR","PSC","SHAREHOLDER","BENEFICIAL_OWNER","TRUSTEE","NOMINEE","SECRETARY","OTHER"]},"description":"The roles of this related party in the parent organisation."}},"required":["object","firstName","lastName"],"description":"Create a new individual and add them as a related party."},{"type":"object","properties":{"object":{"type":"string","enum":["organisation"]},"name":{"type":"string","description":"The name of the organisation."},"type":{"type":"string","enum":["COMPANY","NON_PROFIT","TRUST","OTHER"],"description":"The type of the organisation."},"subType":{"type":"string","description":"The sub type of the organisation."},"identifyingNumber":{"type":"string","description":"The identifying number of the organisation."},"registeredAddress":{"type":"object","properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"description":"The registered address of the organisation."},"tradingAddress":{"type":"object","properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"description":"The trading address of the organisation."},"roles":{"default":[],"type":"array","items":{"type":"string","enum":["DIRECTOR","PSC","SHAREHOLDER","BENEFICIAL_OWNER","TRUSTEE","NOMINEE","SECRETARY","OTHER"]},"description":"The roles of this related party in the parent organisation."}},"required":["object","name","type"],"description":"Create a new organisation and add it as a related party."},{"type":"object","properties":{"object":{"type":"string","enum":["existing"]},"individualId":{"type":"string","description":"The unique identifier for an existing individual to add as a related party. Either individualId or organisationId must be provided, but not both."},"organisationId":{"type":"string","description":"The unique identifier for an existing organisation to add as a related party. Either individualId or organisationId must be provided, but not both."},"roles":{"default":[],"type":"array","items":{"type":"string","enum":["DIRECTOR","PSC","SHAREHOLDER","BENEFICIAL_OWNER","TRUSTEE","NOMINEE","SECRETARY","OTHER"]},"description":"The roles of this related party in the parent organisation."}},"required":["object"],"description":"Create a related party relationship from an existing individual or organisation."}],"description":"Create a related party. Can be from an existing individual/organisation ID, or by providing details to create a new individual or organisation."}}}},"responses":{"201":{"description":"Related party created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the related party relationship."},"object":{"type":"string","enum":["related_party"]},"partyType":{"type":"string","enum":["INDIVIDUAL","ORGANISATION"],"description":"The type of related party. Determines the type of entity that is referenced."},"entity":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the referenced entity."},"object":{"type":"string","enum":["individual","organisation"]}},"required":["links","id","object"],"description":"A reference to the entity that is the related party."},"name":{"type":"string","description":"The name of the related party."},"roles":{"type":"array","items":{"type":"string","enum":["DIRECTOR","PSC","SHAREHOLDER","BENEFICIAL_OWNER","TRUSTEE","NOMINEE","SECRETARY","OTHER"]},"description":"The roles of this related party in the parent organisation."},"isClient":{"type":"boolean","description":"Whether this related party is also a client."},"createdAt":{"type":"string","format":"date-time"}},"required":["links","id","object","partyType","entity","name","roles","isClient","createdAt"],"description":"The main response data"}},"required":["data"],"description":"Related party created successfully"}}}},"404":{"description":"404"},"409":{"description":"409"},"500":{"description":"500"}}}},"/organisations/{organisationId}/related-parties/{relatedPartyId}":{"patch":{"description":"Update the roles of a related party.","summary":"Update a related party","tags":[],"parameters":[{"name":"organisationId","in":"path","required":true,"schema":{"type":"string"},"description":"The unique identifier for the organisation."},{"name":"relatedPartyId","in":"path","required":true,"schema":{"type":"string"},"description":"The unique identifier for the related party."},{"name":"accept-version","in":"header","required":true,"schema":{"type":"string","enum":["1.0.0"]}}],"operationId":"updateRelatedParty","requestBody":{"description":"Body","content":{"application/json":{"schema":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"string","enum":["DIRECTOR","PSC","SHAREHOLDER","BENEFICIAL_OWNER","TRUSTEE","NOMINEE","SECRETARY","OTHER"]},"description":"The new roles for this related party in the parent organisation."}},"required":["roles"],"description":"Update the roles of a related party."}}}},"responses":{"200":{"description":"Related party updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the related party relationship."},"object":{"type":"string","enum":["related_party"]},"partyType":{"type":"string","enum":["INDIVIDUAL","ORGANISATION"],"description":"The type of related party. Determines the type of entity that is referenced."},"entity":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the referenced entity."},"object":{"type":"string","enum":["individual","organisation"]}},"required":["links","id","object"],"description":"A reference to the entity that is the related party."},"name":{"type":"string","description":"The name of the related party."},"roles":{"type":"array","items":{"type":"string","enum":["DIRECTOR","PSC","SHAREHOLDER","BENEFICIAL_OWNER","TRUSTEE","NOMINEE","SECRETARY","OTHER"]},"description":"The roles of this related party in the parent organisation."},"isClient":{"type":"boolean","description":"Whether this related party is also a client."},"createdAt":{"type":"string","format":"date-time"}},"required":["links","id","object","partyType","entity","name","roles","isClient","createdAt"],"description":"The main response data"}},"required":["data"],"description":"Related party updated successfully"}}}},"404":{"description":"404"},"500":{"description":"500"}}},"delete":{"description":"Remove a related party from this organisation. This only removes the relationship; the underlying individual or organisation is not deleted.","summary":"Delete a related party","tags":[],"parameters":[{"name":"organisationId","in":"path","required":true,"schema":{"type":"string"},"description":"The unique identifier for the organisation."},{"name":"relatedPartyId","in":"path","required":true,"schema":{"type":"string"},"description":"The unique identifier for the related party."},{"name":"accept-version","in":"header","required":true,"schema":{"type":"string","enum":["1.0.0"]}}],"operationId":"deleteRelatedParty","responses":{"200":{"description":"200"},"404":{"description":"404"},"500":{"description":"500"}}}},"/sole-traders":{"get":{"description":"Get a list of all sole traders.","summary":"List sole traders","tags":[],"parameters":[{"name":"accept-version","in":"header","required":true,"schema":{"type":"string","enum":["1.0.0"]}},{"name":"cursor","in":"query","description":"Cursor for paginated requests","schema":{"type":"string"}},{"name":"limit","in":"query","description":"The number of results per page","schema":{"default":50,"type":"integer","maximum":200,"nullable":true}}],"operationId":"getSoleTraders","responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the sole trader."},"object":{"type":"string","enum":["sole_trader"]},"tradingName":{"type":"string","description":"The trading name of the sole trader."},"individual":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the individual."},"object":{"type":"string","enum":["individual"]},"firstName":{"type":"string","description":"The first name of the individual."},"middleName":{"type":"string","description":"The middle name of the individual."},"lastName":{"type":"string","description":"The last name of the individual."},"email":{"type":"string","description":"The email address of the individual."},"residentialAddress":{"type":"object","properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"description":"The residential address of the individual."},"birth":{"type":"object","properties":{"day":{"type":"number"},"month":{"type":"number"},"year":{"type":"number"}},"required":["year"],"description":"The birth date of the individual. Split into parts as the full date is not always available."},"client":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the client."}},"required":["links","id"],"description":"A reference to the client associated with this individual, if one exists."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["links","id","object","firstName","lastName","createdAt","updatedAt"],"description":"The individual related to this sole trader."},"client":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the client."}},"required":["links","id"],"description":"A reference to the client associated with this sole trader, if one exists."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["links","id","object","individual","createdAt","updatedAt"],"description":"A sole trader, which is an individual with an associated trading name."},"description":"The main response data"},"meta":{"type":"object","properties":{"next_cursor":{"type":"string","description":"The cursor for the next page of results."},"total":{"type":"number","description":"The total number of results"}},"required":["total"]}},"required":["data","meta"]}}}}}}},"/sole-traders/{id}":{"get":{"description":"Get a single sole trader by its unique identifier.","summary":"Show a sole trader","tags":[],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"The unique identifier for the sole trader."},{"name":"accept-version","in":"header","required":true,"schema":{"type":"string","enum":["1.0.0"]}}],"operationId":"getSoleTrader","responses":{"200":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the sole trader."},"object":{"type":"string","enum":["sole_trader"]},"tradingName":{"type":"string","description":"The trading name of the sole trader."},"individual":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the individual."},"object":{"type":"string","enum":["individual"]},"firstName":{"type":"string","description":"The first name of the individual."},"middleName":{"type":"string","description":"The middle name of the individual."},"lastName":{"type":"string","description":"The last name of the individual."},"email":{"type":"string","description":"The email address of the individual."},"residentialAddress":{"type":"object","properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"description":"The residential address of the individual."},"birth":{"type":"object","properties":{"day":{"type":"number"},"month":{"type":"number"},"year":{"type":"number"}},"required":["year"],"description":"The birth date of the individual. Split into parts as the full date is not always available."},"client":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the client."}},"required":["links","id"],"description":"A reference to the client associated with this individual, if one exists."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["links","id","object","firstName","lastName","createdAt","updatedAt"],"description":"The individual related to this sole trader."},"client":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the client."}},"required":["links","id"],"description":"A reference to the client associated with this sole trader, if one exists."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["links","id","object","individual","createdAt","updatedAt"],"description":"The main response data"}},"required":["data"]}}}},"404":{"description":"404"}}},"patch":{"description":"Update a sole trader. Only the trading name can be updated. The associated individual cannot be changed, but the individual's details can be updated through the individuals API endpoints.","summary":"Update a sole trader","tags":[],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"The unique identifier for the sole trader."},{"name":"accept-version","in":"header","required":true,"schema":{"type":"string","enum":["1.0.0"]}}],"operationId":"updateSoleTrader","requestBody":{"description":"Body","content":{"application/json":{"schema":{"type":"object","properties":{"tradingName":{"type":"string","nullable":true,"description":"The trading name of the sole trader."}},"description":"Fields to update for a sole trader. Only the trading name can be updated."}}}},"responses":{"200":{"description":"Sole trader updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the sole trader."},"object":{"type":"string","enum":["sole_trader"]},"tradingName":{"type":"string","description":"The trading name of the sole trader."},"individual":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the individual."},"object":{"type":"string","enum":["individual"]},"firstName":{"type":"string","description":"The first name of the individual."},"middleName":{"type":"string","description":"The middle name of the individual."},"lastName":{"type":"string","description":"The last name of the individual."},"email":{"type":"string","description":"The email address of the individual."},"residentialAddress":{"type":"object","properties":{"line1":{"type":"string","nullable":true},"line2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"description":"The residential address of the individual."},"birth":{"type":"object","properties":{"day":{"type":"number"},"month":{"type":"number"},"year":{"type":"number"}},"required":["year"],"description":"The birth date of the individual. Split into parts as the full date is not always available."},"client":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the client."}},"required":["links","id"],"description":"A reference to the client associated with this individual, if one exists."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["links","id","object","firstName","lastName","createdAt","updatedAt"],"description":"The individual related to this sole trader."},"client":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The API url for this item"},"web":{"type":"string","format":"uri","description":"The web url for this item"}},"required":["self","web"]},"id":{"type":"string","description":"The unique identifier for the client."}},"required":["links","id"],"description":"A reference to the client associated with this sole trader, if one exists."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["links","id","object","individual","createdAt","updatedAt"],"description":"The main response data"}},"required":["data"],"description":"Sole trader updated successfully"}}}},"404":{"description":"404"},"500":{"description":"500"}}}}},"info":{"title":"Firmcheck API","version":"1.0.0"},"servers":[{"description":"Production","url":"https://api.firmcheck.com"},{"description":"Development","url":"https://api.dev.beta-firmcheck.com"}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}],"x-readme":{"proxy-enabled":false}}