Skip to navigation

Create an Account

View as Markdown

Creates a TaxCloud account and its first contact. Requires a service credential with the create:accounts scope. The new account’s identifier is returned in the response.

Contact

Every account starts with one contact. By default it uses the account email; supply the optional contact object to name a different person. The contact’s status is invited until they accept the terms of service, then active.

Note: Creation is not idempotent and has no replay protection. The contact email must be unique across all TaxCloud contacts, so a repeated call with the same email returns 409 rather than a second account; a repeated call with a different email creates a second account. Do not retry this call automatically.

Authentication

AuthorizationBearer
This authentication type can be used to directly call the service.
OR
X-API-KEYstring
This authentication type is supported by using the provided API key for the merchant account.

Request

This endpoint expects an object.
emailstringRequiredformat: "email"3-100 characters
Primary email for the account. Must be a bare address with no display name. On create, also used for the account's first contact unless a contact object overrides it.
namestringRequired1-50 characters
Legal or trading name of the account. Maximum 50 characters.
contactobjectOptional
Optional first contact for the account. Use this when the account email is a shared inbox rather than an individual. When omitted, the contact is created against the account email with no name.
einstringOptional<=12 characters
Optional Employer Identification Number. Maximum 12 characters.
phonestringOptional<=16 characters
Optional account phone number. Maximum 16 characters.
stateIncorporatedstringOptionalformat: "^[A-Za-z]{2}$"=2 characters

Optional two-letter state code where the business is incorporated.

Response

Created
accountIdlong
Identifier of the account.
createdAtstringformat: "date-time"
When the account was created. Stored to the minute.
emailstring
Primary email for the account.
namestring
Name of the account.
$schemastringOptionalRead-onlyformat: "uri"
A URL to the JSON Schema for this object.
contactobjectOptional
The account's first contact. Returned by create only.
einstringOptional
Employer Identification Number, when one was supplied.
phonestringOptional
Account phone number, when one was supplied.
stateIncorporatedstringOptional
State of incorporation, when one was supplied.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error