These endpoints tell you where the onboarding stands and move it forward.
| Endpoint | Use it to |
|---|---|
| Retrieve onboarding status | See the status, what is still missing, the contract, identity verification, and open requests in one call. |
| Submit for review | Lock the draft and start Everee's review. Works only when nothing is missing. |
| Withdraw the onboarding | Withdraw a company that is a draft or under review. It can't be reopened. |
| Retire a Sandbox company | Retire a Sandbox company you no longer need. It frees a live slot. |
| Get go-live status | See whether the company is live, its go-live dates, and what's outstanding. |
| Set the target go-live date | Tell Everee when you want the company to go live. |
A company is a DRAFT until you submit it, then UNDER_REVIEW, then APPROVED or DECLINED. See Statuses. Poll the status endpoint, or use it to reconcile after you receive a webhook event.
For what happens during and after review, see Submitting for review. An approved company isn't live yet: see Payroll history and going live.