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, sent as an HTTP Basic credential: Authorization: Basic base64(<key>:). See Authentication. The key decides what you create: your test key (zk_test_2…) creates a Sandbox company and your production key (zk_prod_2…) creates a Production company.
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, supporting documents, 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. |
taxContact | Defaults to primaryContact. |
agreementConsent | Optional, and only for partners whose customers agree to terms under the partner's own agreement. The customer's consent, if you already have it. See Agreeing to terms. You can also report it later. |
webhookUrl | Optional. Must be an https URL on a public host. When you give one, Everee creates the company's first webhook endpoint. You can change it, add more and rotate its signing key later with the Webhook Endpoints API, using the company's API key. |
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. Returned only in this response, so store it; later reads of the endpoint show it masked.
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. |
403 | You used a production key, but Everee has not yet approved your integration for Production. Create companies with your test key until it is. |
409 | You sent agreementConsent, but your customers sign the Subscription Agreement themselves, or your partner account has no agreement in effect yet. Nothing is created. |
422 | A required field is missing or malformed, for example an ein that isn't nine digits, or a webhookUrl that isn't https. |
429 | You used your test key and reached a limit on Sandbox companies: 25 alive at once, or 50 created in the last 7 days. The message says which, and when you can create the next one. Nothing is created. |