THthredfi
Business Management

Create business (idempotent)

    Create a new business with idempotency support via external_id.

    **Supported Markets**: EU/UK, Nordic, and APAC countries (GB, DE, FR, NL, ES, BE, IT, IE, AT, PT, SE, NO, DK, FI, IS, MY, SG)

    **Entity Type Validation**:
    - **GB, DE, NL, ES, BE, MY, SG**: Must use country-specific entity types (see documentation)
    - **All other countries**: Any entity type string is accepted

    **Idempotency**: If a business with the same external_id already exists for your partner,
    this endpoint will return the existing business (HTTP 200) instead of creating a duplicate.

    **Response Metadata**: Includes `_meta` field indicating creation vs idempotent return.

    **Required Fields**: external_id, legal_name, entity_type, email
post/v1/platform/businesses/

Request

  • Base URL
    https://docs.thredfi.com (the document declares no server; this is the origin it was published from)
  • Auth
    • HTTP bearer
    • or HTTP bearer
    • or HTTP basic
    • or HTTP bearer
    • or HTTP bearer

Request body

external_idstring required

Your unique identifier for this business (used for idempotency)

legal_namestring required

Legal registered name of the business

entity_typestring required

Business entity type (e.g., 'limited', 'gmbh', 'bv'). Validated for GB, DE, NL, ES, BE. Any string accepted for other countries.

phone_numberstring

Business phone number

tinstring

Tax identification number (other than VAT)

vat_numberstring

EU VAT registration number

company_numberstring

Company registration number (e.g., Companies House number for UK)

countrystring

ISO 3166-1 alpha-2 country code (e.g., GB, DE, NL, ES, MY, SG)

provincestring

Province or state within the country

eu_nace_industry_codestring

European NACE industry classification code

emailstring email required

Primary email address for the business

base_currencystring

Base currency for accounting (ISO 4217 code: EUR, GBP, USD, SEK, NOK, DKK, ISK, MYR, SGD)

accounting_method'cash' | 'accrual'

Accounting method: 'cash' or 'accrual' (default: accrual)

  • cash - Cash Basis
  • accrual - Accrual Basis
fiscal_year_endstring date

Fiscal year end date (format: YYYY-MM-DD, e.g., '2024-03-31' for March 31st year-end)

metadataunknown

Response

idstring uuid required

Unique identifier for the business

external_idstring

Your unique identifier for this business

legal_namestring required

Legal registered name of the business

namestring

Display name for the business (defaults to legal_name)

entity_typestring

Business entity type (e.g., 'limited', 'gmbh', 'bv')

phone_numberstring

Business phone number

tinstring

Tax identification number (other than VAT)

vat_numberstring

EU VAT registration number

company_numberstring

Company registration number (e.g., Companies House number for UK)

countrystring required

ISO 3166-1 alpha-2 country code (e.g., GB, DE, NL, MY, SG)

provincestring

Province or state within the country

eu_nace_industry_codestring

European NACE industry classification code

emailstring email required

Primary email address for the business

base_currencystring required

Base currency for accounting (ISO 4217 code)

accounting_methodstring required

Accounting method: 'cash' or 'accrual'

fiscal_year_endstring date required

Fiscal year end date

activation_atstring date-time required

Date and time when the business was activated

is_activeboolean required

Whether the business is active (false if archived)

created_atstring date-time required

Date and time when the business was created

updated_atstring date-time required

Date and time when the business was last updated

metadataunknown

Changes

No recorded changes to this operation across all 1 revision of this API.