latestOpenAPI 3.0.02026-08-15122834.2 KB

fea4b2a0d73d

Businesses

Create a business

post/api/platform/v1/businesses

Request body

namestring required

The name of the business. Must be unique.

addressAddress

einobject

The business EIN. Only digits, no formatting.

phoneNumberstring

The business phone number. No formatting characters, country code is optional.

Example request

{
  "name": "My Business",
  "phoneNumber": "+14155556789"
}

Response

Business exists already with the name. Returning existing business.

namestring required

The name of the business. Must be unique.

addressAddress

einobject

The business EIN. Only digits, no formatting.

phoneNumberstring

The business phone number. No formatting characters, country code is optional.

idstring required

UUID

createdAtstring required

ISO timestamp

updatedAtstring required

ISO timestamp

Example response

{
  "name": "My Business",
  "phoneNumber": "+14155556789",
  "id": "1193fdaf-630c-4771-a629-8da7a87947d2",
  "createdAt": "2022-06-01T03:57:26.115Z",
  "updatedAt": "2022-06-01T03:57:26.115Z"
}