ClientImportRequestDto - SodiumHQ API Schema

Properties

Name	Type	Description
externalIds	array of string	List of external IDs to import from the third-party platform. Ignored when ImportAll is true.
List of external IDs to import from the third-party platform. Ignored when ImportAll is true.
importAll	boolean	When true, imports every available client from the platform and ignores ExternalIds.
When true, imports every available client from the platform and ignores ExternalIds.
enrichFromCompaniesHouse	boolean	When true, newly imported companies are enriched with Companies House data (business details, key dates, officer contacts). Individuals, sole traders, trusts and associations are never enriched.
When true, newly imported companies are enriched with Companies House data (business details, key dates, officer contacts). Individuals, sole traders, trusts and associations are never enriched.
defaultClientType	enum	PrivateLimitedCompany PublicLimitedCompany LimitedLiabilityPartnership Partnership Individual Trust Charity SoleTrader Association
PrivateLimitedCompany PublicLimitedCompany LimitedLiabilityPartnership Partnership Individual Trust Charity SoleTrader Association

{
  "externalIds": [
    "string"
  ],
  "importAll": false,
  "enrichFromCompaniesHouse": false,
  "defaultClientType": "PrivateLimitedCompany"
}