Businesses

Create a business

Changed on

Creates a business.

Supports both corporate and sole trader business types, each with a different set of required fields.

See the Business accounts guide (TOL / BYOL) for implementation details.

post/businesses

Request

  • Base URL: https://sandbox.upvest.co
  • URL: https://sandbox.upvest.co/businesses
  • Auth: OAuth 2 (client credentials, token URL https://sandbox.upvest.co/auth/token, scopes: businesses:admin)

Headers

idempotency-keystring uuid required
Example:ccb07f42-4104-44ad-8e1f-c660bb7b269c

A UUID to be used as an idempotency key. This prevents a duplicate request from being replayed. https://docs.upvest.co/documentation/concepts/api_concepts/idempotency

Request body

OR

Response

Business created.

OR

Changes

  • 7b1640fd8a62Revision changes
    • breaking

      request property / was restricted to a list of enum values

    • breaking

      the / request property type changed from no type to string

    • breaking

      the response property // became optional for the status

    • breaking

      the / response's property type changed from no type to string for status

    • warning

      added the new LIMITED_LIABILITY_COMPANY enum value to the / response property for the response status

    • info

      the request property // became optional

    • info

      the request property / became optional

    • info

      the request property default value LIMITED_LIABILITY_COMPANY was removed

    • info

      added the new LIMITED_LIABILITY_COMPANY enum value to the request property /

    • info

      the response's property default value LIMITED_LIABILITY_COMPANY was removed for the status

  • eb94c0091916Revision changes
    • breaking

      added the pattern ^[A-Z0-9]{18}[0-9]{2}$ to the request property //

    • info

      the // response's property pattern ^[A-Z0-9]{18}[0-9]{2}$ was added for the status