Sign in
Companies/Entities

Create a new company

Create a new company to use as an entity that you manage

post/v1/companies

Request body

namestring required

The name of the company

type'INDIVIDUAL' | 'BUSINESS'

Type of company to create

sandboxboolean

Set company as a sandbox which will prevent it from withdrawing funds to a bank account but can be used for testing

relationship'PAYEE' | 'CLIENT' | 'FULL'

The relationship between the managing metal company and this company. Payee is the default and is a company that can receive payments. Client means they can be invoiced and Full allows for both.

billing_emailstring

For companies that will be issued invoices (payees) specify the email address that should be attached to those invoices

generate_onboard_linkboolean

Only supported for client companies right now, this will generate a link for them to fill in details of their business themselves

Example request

{
  "name": "John Doe"
}

Response

The new Company object

Example response

{
  "data": {
    "id": "c_qaz2wsxx",
    "name": "Test Company"
  }
}