Update a draft company's legal details, address and phone number.
Use this endpoint to fill in or change a company's details while it's being onboarded. It is a partial update: any field you leave out (or send as null) keeps its current value. To clear tradeName, website, or businessPhone, send an empty string.
Part of Company details. For how this fits into onboarding, see the guide: Collecting company information: company details.
When you can call this
The company's details appear on the contract documents, so they can only be changed while the onboarding is a DRAFT and the documents haven't been signed. Once the signer signs, or once the onboarding is submitted, this endpoint returns 409.
Field notes
| Field | Notes |
|---|---|
legalBusinessName, tradeName | If the company has no separate trade name, changing the legal name also changes the name it's displayed under. The response's tradeName is null when it's the same as the legal name. Send an empty tradeName to remove the trade name, so the company is shown under its legal name again. |
website | Send an empty string to remove it. |
ein | Returned formatted as 12-3456789. |
businessPhone | Returned as 10 digits. Send an empty string to remove it. |
legalEntityType | One of C_CORPORATION, S_CORPORATION, LLC_MULTI_MEMBER, LLC_SINGLE_MEMBER, PARTNERSHIP, SOLE_PROPRIETORSHIP, NONPROFIT, OTHER. |
address | When you send an address, send all of line1, city, state and postalCode. It replaces the company's draft address rather than adding another. |
dueDiligence | Optional pay card underwriting details. It isn't echoed in the response. |
legalEntityType, formationState and address are required before the company can be submitted. They show up in readiness.missing as LEGAL_ENTITY_TYPE, FORMATION_STATE and BUSINESS_ADDRESS.
Errors
| Status | Meaning |
|---|---|
401 | The API key is missing, malformed or expired. |
404 | No company with this ID belongs to your partner account. |
409 | The onboarding is no longer a DRAFT, or the contract has been signed. |
422 | A value is malformed, for example an ein that isn't nine digits or a postalCode that isn't a ZIP code. |