Start a client company's onboarding as a draft and receive its API key.
Use this endpoint to start onboarding a client company. It creates the company in DRAFT status. You then fill in the rest of the onboarding data with the other endpoints in this section.
Part of Company details. For how this fits into onboarding, see the guide: Collecting company information: create the company.
Authenticate every request in this section with your partner API key (it starts with prtk_), sent as an HTTP Basic credential: Authorization: Basic base64(<key>:). See Authentication.
What you send
Only the basics are needed to create the company: the legal business name, the EIN and a primary contact. Everything else (company details, payroll profile, contacts, signer, control person, beneficial owners and tax setup) is added afterward.
| Field | Notes |
|---|---|
ein | Nine digits, with or without the dash. It's returned formatted as 12-3456789. |
primaryContact | Everee creates the company's first user from this person. This contact is not added to the company's contact list (see Add a contact). |
taxContact | Defaults to primaryContact. |
webhookUrl | Optional. Must be an https URL on a public host. You can also set or change it later with Set the company's webhook. |
The company's ACH funding bank account is not supplied here. The company's signer chooses it with Plaid while signing the contract documents.
The response
The response is the company, in DRAFT onboarding status. It also includes:
apiKey: an API key for the new company. It is shown only in this response and can never be retrieved again, so store it securely.webhookSigningKey: present only when you supplied awebhookUrl.
Errors
| Status | Meaning |
|---|---|
400 | webhookUrl points at something other than a public host, or contains credentials or a fragment. Nothing is created. |
401 | The API key is missing, malformed or expired. |
422 | A required field is missing or malformed, for example an ein that isn't nine digits, or a webhookUrl that isn't https. |