get
https://api.everee.com/integration/v1/partner/companies//status
See what's missing before a company can be submitted, and how review is going.
Use this endpoint to see everything about where a company is in onboarding in one call. Poll it, or use it to reconcile after you receive a webhook.
Part of Submission and status. For how this fits into onboarding, see the guide: Overview: the readiness check.
Lifecycle
status | Meaning |
|---|---|
DRAFT | You're filling in the onboarding. Data can be edited until the contract is signed. |
UNDER_REVIEW | Submitted. Everee is reviewing and may open requests. |
APPROVED | Approved. |
DECLINED | Declined. decision.reasonCode carries a generic reason code. |
WITHDRAWN | Withdrawn. Final. |
Readiness
readiness.missing lists what still has to happen before Submit will succeed. Each is a code:
| Code | What it needs |
|---|---|
LEGAL_ENTITY_TYPE, FORMATION_STATE, BUSINESS_ADDRESS | Company details |
WORKER_TYPES, EMPLOYEE_COUNT, CONTRACTOR_COUNT, PAY_FREQUENCY, PAY_PERIOD_START_DAY, ANNUAL_REVENUE, NATURE_OF_BUSINESS, NAICS_CODE | Payroll profile |
CONTACTS, PRIMARY_CONTACT | Contacts, with one primary |
SIGNER, SIGNER_IDENTITY, SIGNER_RELATIONSHIP | Signer |
CONTROL_PERSON | Control person |
OWNERSHIP_DECLARATION, OWNERSHIP_TOTAL | Ownership declaration and beneficial owners that agree with it and don't exceed 100% in total |
TAX_STATES | Tax setup, for companies that pay W-2 employees |
CERTIFICATE_OF_AUTHORITY | Certificate of authority, for a signer who is neither the control person nor an owner |
SIGNED_CONTRACT, BANK_ACCOUNT | The signer signing the documents and selecting the bank in the hosted experience |
Other fields
| Field | Notes |
|---|---|
released | Whether the contract-signing workflow is open for the company. It is true for companies you create through this API. |
takeoverRequired | Used for Everee's own customers who onboard themselves. Always false for partner companies. |
identityVerification | One entry per person being verified. status is GETTING_READY, LINK_SENT, IN_REVIEW, EXPIRED_CONTACT_US or VERIFIED. Outcomes other than verified or expired are deliberately shown as IN_REVIEW. |
requests | Everee's review requests, open and resolved. See List review requests. |
contract | A summary of the contract. Absent until a signature has been requested. |
status | Absent only for a company that has no onboarding at all. |
Errors
| Status | Meaning |
|---|---|
401 | The API key is missing, malformed or expired. |
404 | No company with this ID belongs to your partner account. |